Reference Id | CCVPN Use Case Reference | AAI Schema Reference | AAI Proposed Schema |
---|
AAI-1353-1 |
| aai_schema_v13.xsd | Update existing "network" and "business" entry points to graph for new proposed elements: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="Network">
<xml-root-element name="network"/>
<java-attributes>
<xml-element name="connectivities"
type="inventory.aai.onap.org.v14.Connectivities"/>
<xml-element name="lan-port-configs"
type="inventory.aai.onap.org.v14.PortConfigsLanPortConfigs"/>
<xml-element name="network-resources"
type="inventory.aai.onap.org.v14.NetworkResources"/>
<xml-element name="site-resources"
type="inventory.aai.onap.org.v14.SiteResources"/>
</java-attributes>
</java-type>
<java-type <xml-element name="Businesssdwan-vpns">
<xml-root-element nametype="businessinventory.aai.onap.org.v14.SdwanVpns"/>
<java-attributes>
<xml-element name="sp-partnersdevices"
type="inventory.aai.onap.org.v14.SpPartnersDevices"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="network">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:connectivities <xml-element name="wan-port-configs"
type="inventory.aai.onap.org.v14.WanPortConfigs"/>
<xml-element name="ext-aai-networks"
minOccurs="0" maxOccurs="unboundedtype="inventory.aai.onap.org.v14.ExtAaiNetworks"/>
<xs:element ref="tns:port-configs"
minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="tns:network-resources</java-attributes>
</java-type>
<java-type name="Business">
<xml-root-element name="business"/>
<java-attributes>
<xml-element name="sp-partners"
minOccurs="0" maxOccurs="unboundedtype="inventory.aai.onap.org.v14.SpPartners"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="business">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:sp-partners"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
java-attributes>
</java-type>
|
|
AAI-1353-2 | SOTN Infra Closed Loop Site Service Instance Notes: | AAI-1353-2 | SOTN Infra Closed Loop Site Service Instance Notes: See Figure 2 above. Use existing class of objects. Closed loop scenario: - SO will create “service-instance” object in AAI
- SO will store “customer-request” string on service-instance object in AAI
- When Closed Loop call recreates the “service-instance”, it will query “service-instance” information first, to get the “customer-request”
| aai_schema_v13.xsd - "service-instance"
- "service-instances"
| add properties to existing "service-instance" object: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="ServiceInstance">
<xml-root-element name="service-instance"/>
<java-attributes>
<xml-element name="customerinput-requestsparameters" type="java.lang.String"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="service-instance">
<xs:complexType>
<xs:sequence>
<xs:element name="customer-requests" type="xs:string">
</xs:sequence>
</xs:complexType>
</xs:element>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/business
/customers/customer/{global-customer-id}
/service-subscriptions/service-subscription/{service-type}
/service-instances/service-instance/{service-instance-id}
Method: PUT
Request Body:
{
service-instance-id: "{service-instance-id}",
service-instance-name: "instance name",
service-type: "some type",
service-role: "some role",
resource-version: "some version",
model-invariant-id: "model id",
model-version-id: "model version",
customerinput-requestsparameters: "request parameters"
}
|
|
AAI-1353-3 | SOTN Connectivity Notes: See Figure 2 above. Proposal for specific new class of "connectivity" objects. Key value is "Ethernet Service Name" property. | aai_schema_v13.xsd - "service-instancesinstance"
- "vpn-bindings"
| new element "connectivity" , with 10-12 properties and 1-2 relationships and new element "connectivities": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="Connectivity">
<xml-root-element name="connectivity"/>
<java-attributes>
<xml-element name="ethtconnectivity-svc-nameid" type="java.lang.String"/>
<xml-element name="bandwidth-profile-name" type="java.lang.String"/>
<xml-element name="bandwidth-profilevpn-type" type="java.lang.String"/>
<xml-element name="CIRcir" type="java.lang.String"/>
<xml-element name="EIReir" type="java.lang.String"/>
<xml-element name="CBScbs" type="java.lang.String"/>
<xml-element name="EBSebs" type="java.lang.String"/>
<xml-element name="color-aware" type="java.lang.String"/>
<xml-element name="coupling-flag" type="java.lang.String"/>
<xml-element name="accessetht-providersvc-idname" type="java.lang.String"/>
<xml-element name="access-clientprovider-id" type="java.lang.String"/>
<xml-element name="access-topologyclient-id" type="java.lang.String"/>
<xml-element name="access-nodetopology-id" type="java.lang.String"/>
<xml-element name="access-ltpnode-id" type="java.lang.String"/>
<xml-element name="cvlanaccess-tagltp-entryid"
type="inventoryjava.aai.onap.org.v14.CvlanTagEntrylang.String"/>
<xml-element name="serviceconnectivity-instanceselflink"
type="inventoryjava.aai.onap.org.v14.ServiceInstancelang.String"/>
<xml-element name="vpn-bindingscvlan"
type="inventoryjava.aai.onap.org.v14.VpnBindingslang.String"/>
</java-attributes>
</java-type>
<java-type name="Connectivities">
<xml-root-element name="connectivities"/>
<java-attributes> <xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="model-customization-id" type="java.lang.String"/>
<xml-element name="model-version-id" type="java.lang.String"/>
<xml-element name="connectivitymodel-invariant-id" container-type="java.lang.ArrayList"String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.ConnectivityRelationshipList"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element<java-type name="connectivityConnectivities">
<xs:complexType>
<xs:sequence>
<xs:<xml-root-element name="etht-svc-name" type="xs:string" minOccurs="1"connectivities"/>
<java-attributes>
<xs:<xml-element name="bandwidth-profile-nameconnectivity" container-type="xs:string">
java.lang.ArrayList"
<xs:element name="bandwidth-profile-type" type="xs:string">
<xs:element name="CIR" type="xs:string">
<xs:element name="EIR" type="xs:string">
<xs:element name="CBS" type="xs:string">
<xs:element name="EBS" type="xs:string">
<xs:element name="color-aware" type="xs:string">
<xs:element name="coupling-flag" type="xs:string">
<xs:element name="access-provider-id" type="xs:string">
<xs:element name="access-client-id" type="xs:string">
<xs:element name="access-topology-id" type="xs:string">
<xs:element name="access-node-id" type="xs:string">
<xs:element name="access-ltp-id" type="xs:string">
<xs:element ref="tns:cvlan-tag-entry"
minOccurs="0" maxOccurs="1"/>
<xs:element ref="tns:service-instance"
minOccurs="0" maxOccurs="1"/>
<xs:element ref="tns:vpn-bindings"
minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="connectivities">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:connectivity"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
="inventory.aai.onap.org.v14.Connectivity"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/connectivities/connectivity/{connectivityId}
Method: PUT
Request Body:
{
"connectivity-id": "{connectivityId}",
"bandwidth-profile-name": "a name",
"vpn-type": "a type",
"cir": "cir value",
"eir": "eir value",
"cbs": "cbs value",
"ebs": "ebs value",
"color-aware": "color value",
"coupling-flag": "flag value",
"etht-svc-name": "some name",
"access-provider-id": "provider id",
"access-client-id": "client id",
"access-topology-id": "topology id",
"access-node-id": "node id",
"access-ltp-id": "ltp id",
"connectivity-selflink": "some link",
"cvlan": "some tag",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
},
{
"related-to": "vpn-binding",
| Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/connectivities/connectivity/{ethSvcName}
Method: PUT
Request Body:
{
"bandwidth-profile-name": "a name",
"bandwidth-profile-type": "a type",
"CIR": "cir value",
"EIR": "eir value",
"CBS": "cbs value",
"EBS": "ebs value",
"color-aware": "color value",
"coupling-flag": "flag value",
"etht-svc-name": "{ethSvcName}",
"access-provider-id": "provider id",
"access-client-id": "client id",
"access-topology-id": "topology id",
"access-node-id": "node id",
"access-ltp-id": "ltp id",
"cvlan-tag-entry": {
"cvlan-tag" : "cvlanTag"
},
"service-instance": {
"service-instance-id" : "instance id"
},
"vpn-bindings": {
"vpn-binding" : [
{
"related-link": "url of vpn-binding",
"vpnrelationship-iddata": "vpn[
id 1"
},
"relationship-key": "vpn-binding.vpn-id",
{
"vpnrelationship-idvalue": "vpnsome id 2""
]
}
]
}
}
|
|
AAI-1353-4 | VPN Notes: See Figure 2 above. Update existing class of objects.
| aai_schema_v13.xsd - "vpn-binding"
- "vpn-bindings"
| add properties to existing "vpn-binding" object: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="VpnBinding">
<xml-root-element name="vpn-binding"/>
<java-attributes>
<xml-element name="access-provider-id" type="java.lang.String"/>
<xml-element name="access-client-id" type="java.lang.String"/>
<xml-element name="access-topology-id" type="java.lang.String"/>
<xml-element name="access-node-id" type="java.lang.String"/>
<xml-element name="access-ltp-id" type="java.lang.String"/>
<xml-element name="src-access-node-id" type="java.lang.String"/>
<xml-element name="src-access-ltp-id" type="java.lang.String"/>
<xml-element name="dst-access-node-id" type="java.lang.String"/>
<xml-element name="dst-access-ltp-id" type="java.lang.String"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="vpn-binding">
<xs:complexType>
<xs:sequence>
<xs: <xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="accessmodel-providercustomization-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="accessmodel-clientversion-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="accessmodel-topologyinvariant-id" type="xs:string">
<xs:element name="src-access-node-id" type="xs:string">java.lang.String"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/vpn-bindings/vpn-binding/vpnId
Method: PUT
Request Body:
{
<xs:element name="src-access-ltp"vpn-id": type="xs:stringvpnId">,
<xs"vpn-name":element name="dst-access-node-id" type="xs:string"> "vpn name",
"access-provider-id": "provider id",
"access-client-id": "client id",
<xs:element name="dst"access-topology-id": "topology id",
"src-access-ltpnode-id": type="xs:string">
</xs:sequence>
</xs:complexType>
</xs:element>
| Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/vpn-bindings/vpn-binding/vpnId
Method: PUT
Request Body:
{"src node id",
"src-access-ltp-id": "src ltp id",
"dst-access-node-id": "dst node id",
"vpndst-access-ltp-id": "vpnIddst ltp id",
"vpnoperational-namestatus": "vpnsome namestatus",
"accessmodel-providercustomization-id": "providersome idcustomization",
"accessmodel-clientversion-id": "clientsome idversion",
"accessmodel-topologyinvariant-id": "topology id",
"src-access-node-id": "src node id",
"src-access-ltp-id": "src ltp id",
"dst-access-node-id": "dst node id",
"dst-access-ltp-id": "dst ltp id"
some invariant"
}
|
|
AAI-1353-5 | SP Partner Notes: See Figure 2 above. Proposal for specific new class of "sp-partner" objects.
| aai_schema_v13.xsd | new element "sp-partner" and new element "sp-partners": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="SpPartner">
<xml-root-element name="sp-partner"/>
<java-attributes>
<xml-element name="sp-partner-id" type="java.lang.String"/>
<xml-element name="url" type="java.lang.String"/>
<xml-element name="callsource" type="java.lang.String"/>
<xml-element name="servicerelationship-instancelist"
type="inventory.aai.onap.org.v14.ServiceInstanceRelationshipList"/>
</java-attributes>
</java-type>
<java-type name="SpPartners">
<xml-root-element name="sp-partners"/>
<java-attributes>
<xml-element name="sp-partner"
type="inventory.aai.onap.org.v14.SpPartner"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | xmljs |
---|
title | Mockup Schema (XSD)API |
---|
collapse | true |
---|
| <xs:element name="sp-partner">
<xs:complexType>
<xs:sequence>
<xs:element name="id" type="xs:string">URL: https://<AAI host>:<AAI port>/aai/v14/business
/sp-partners/sp-partner/partnerId
Method: PUT
Request Body:
{
"sp-partner-id": "partnerId",
<xs"url":element name="partner url" type="xs:string">,
<xs"callsource":element ref="tns:service-instance"
"some source",
minOccurs="0relationship-list" maxOccurs="1"/>
: {
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="sp-partnersrelationship">
<xs:complexType>
[
<xs:sequence>
<xs:element ref="tns:sp-partner" {
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element> | Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/business
/sp-partners/sp-partner/partnerId
Method: PUT
Request Body:
{
"idrelated-to": "partnerIdservice-instance",
"url": "partner url",
" "related-link": "url of service-instance",
"relationship-data": {[
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "instancesome id"
}
}
]
}
]
}
}
|
|
AAI-1353-6 | SOTN Attachment Notes: See Figure 3 above. Update existing class of objects.
| aai_schema_v13.xsd - "allotted-resource"
- "allotted-resources"
| add properties to existing "allotted-resource" object: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="AllottedResource">
<xml-root-element name="allotted-resource"/>
<java-attributes>
<xml-element name="allotted-resource-name" type="java.lang.String"/>
<xml-element name="access-provider-id" type="java.lang.String"/>
<xml-element name="access-client-id" type="java.lang.String"/>
<xml-element name="access-topology-id" type="java.lang.String"/>
<xml-element name="access-node-id" type="java.lang.String"/>
<xml-element name="access-ltp-id" type="java.lang.String"/>
<xml-element name="cvlan-tag-entry" type="java.lang.String"/>
<xml-element name="vpn-name" type="inventoryjava.aai.onap.org.v14.CvlanTagEntrylang.String"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | xmljs |
---|
title | Mockup Schema (XSD)API |
---|
collapse | true |
---|
| <xs:element name="allotted-resource">
<xs:complexType>
<xs:sequence>URL: https://<AAI host>:<AAI port>/aai/v14/business
/customers/customer/{global-customer-id}
/service-subscriptions/service-subscription/{service-type}
/service-instances/service-instance/{service-instance-id}
/allotted-resources/allotted-resource/{id}
Method: PUT
Request Body:
{
<xs:element name="access-provider-id" type="xs:string">"allotted-resource-name": "some name",
"access-provider-id": "provider id",
<xs:element name="access-client-id": type="xs:string">"client id",
<xs:element name="access-topology-id": type="xs:string">
"topology id",
<xs:element name="access-node-id": type="xs:string">"node id",
<xs:element name="access-ltp-id": type="xs:string">"ltp id",
<xs"cvlan":element ref="tns:cvlan-tag-entry"
"some tag",
minOccurs="0vpn-name": maxOccurs="1some name"/>
</xs:sequence>
</xs:complexType>
</xs:element>
}
|
|
AAI-1353-7 | LAN port config Notes: See Figure 3 above. Proposal for specific new class of "lan-port-config" objects.
| aai_schema_v13.xsd | new element "lan-port-config" and new element "lan-port-configs": | js | API |
URL: https://<AAI host>:<AAI port>/aai/v14/business
/customers/customer/{global-customer-id}
/service-subscriptions/service-subscription/{service-type}
/service-instances/service-instance/{service-instance-id}
/allotted-resources/allotted-resource/{id}
Method: PUT
Request Body:
{
"access-provider-id": "provider id",
"access-client-id": "client id",
"access-topology-id": "topology id",
"access-node-id": "node id",
"access-ltp-id": "ltp id",
"cvlan-tag-entry": {
"cvlan-tag" : "cvlanTag"
}
}
|
AAI-1353-7 | LAN port config
WAN port config
Notes:
See Figure 3 above.
Proposal for specific new class of "port-config" objects.
aai_schema_v13.xsd | new element "port-config" and new element "port-configs":
<java-type name="LanPortConfig">
<xml-root-element name="lan-port-config"/>
<java-attributes>
<xml-element name="lan-port-config-id" type="java.lang.String"/>
<xml-element name="lan-port-config-name" type="java.lang.String"/>
<xml-element name="description" type="java.lang.String"/>
<xml-element name="device-id" type="java.lang.String"/>
<xml-element name="port-id" type="java.lang.String"/>
<xml-element name="ip-address" type="java.lang.String"/>
<xml-element name="vlan-tag" type="java.lang.String"/>
<xml-element name="input-bandwidth" type="java.lang.String"/>
<xml-element name="output-bandwidth" type="java.lang.String"/>
<xml-element name="dhcp-services"
type="inventory.aai.onap.org.v14.DhcpServices"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="LanPortConfigs">
<xml-root-element name="lan-port-configs"/>
<java-attributes>
<xml-element name="lan-port-config" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.LanPortConfigs"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/lan-port-configs/lan-port-config/id
Method: PUT
Request Body:
{
"lan-port-config-id": "id",
"lan-port-config-name": "some name",
"description": "some description",
"device-id": "some device",
"port-id": "some port",
"ip-address": "some address",
"vlan-tag": "some tag",
"input-bandwidth": "some input",
"output-bandwidth": "some output",
"dhcp-services": {
"dhcp-service": [
{
"service-enable": "some enable",
"dhcp-service-type": "some service",
"lease-time": "some time",
"domain-name": "some domain",
"dns": "some dns",
"ntp-primary": "some ntp",
"ntp-secondary": "some secondary",
"nbns": "some nbns",
"server-ip-address": "some server"
}
]
},
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
}
]
}
}
|
| AAI-1353-7b | dhcp-service |
| new element "dhcp-service" and new element "dhcp-services", as sub-component of "lan-port-config": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="DhcpService">
<xml-root-element name="dhcp-service"/>
<java-attributes>
<xml-element name="service-enable" type="java.lang.String"/>
<xml-element name="dhcp-service-type" type="java.lang.String"/>
<xml-element name="lease-time" type="java.lang.String"/>
<xml-element name="domain-name" type="java.lang.String"/>
<xml-element name="dns" type="java.lang.String"/>
<xml-element name="ntp-primary" type="java.lang.String"/>
<xml-element name="ntp-secondary" type="java.lang.String"/>
<xml-element name="nbns" type="java.lang.String"/>
<xml-element name="server-ip-address" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="DhcpServices">
<xml-root-element name="dhcp-services"/>
<java-attributes>
<xml-element name="dhcp-service" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.DhcpService"/>
</java-attributes>
</java-type> |
|
AAI-1353-8 | site-resource Notes: See Figure 3 above. |
| new element "site-resource" and new element "site-resources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="SiteResource">
<xml-root-element name="site-resource"/>
<java-attributes>
<xml-element name="site-resource-id" type="java.lang.String"/>
<xml-element name="site-resource-name" type="java.lang.String"/>
<xml-element name="description" type="java.lang.String"/>
<xml-element name="type" type="java.lang.String"/>
<xml-element name="role" type="java.lang.String"/>
<xml-element name="generated-site-id" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
<xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="model-customization-id" type="java.lang.String"/>
<xml-element name="model-version-id" type="java.lang.String"/>
<xml-element name="model-invariant-id" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="SiteResources">
<xml-root-element name="site-resources"/>
<java-attributes>
<xml-element name="site-resource" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.SiteResource"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/site-resources/site-resource/{id}
Method: PUT
Request Body:
{
"site-resource-id": "{id}",
"site-resource-name": "some name",
"description": "some description",
"type": "some type",
"role": "some role",
"generated-site-id": "some id",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
},
{
"related-to": "complex",
"related-link": "url of complex",
"relationship-data": [
"relationship-key": "complex.physical-location-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-9 | physical location Notes: See Figure 3 above. | aai_schema_v13.xsd | use existing element "complex" to represent "physical location".
|
AAI-1353-10 | topo-network Notes: See Figure 4 above. Proposal for specific new class of "network-resource" objects.
| aai_schema_v13.xsd - "pnfs"
- "p-interfaces"
- "vpn-bindings"
| new element "network-resource" and new element "network-resources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="networkResource">
<xml-root-element name="network-resource"/>
<java-attributes>
<xml-element name="network-id" type="java.lang.String"/>
<xml-element name="provider-id" type="java.lang.String"/>
<xml-element name="client-id" type="java.lang.String"/>
<xml-element name="te-topo-id" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
<xml-element name="pnfs"
type="inventory.aai.onap.org.v14.Pnfs"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="networkResources">
<xml-root-element name="network-resources"/>
<java-attributes>
<xml-element name="network-resource" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.NetworkResource"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/network-resources/network-resource/{networkId}
Method: PUT
Request Body:
{
"network-id": "{networkId}",
"provider-id": "some provider",
"client-id": "some client",
"te-topo-id": "some topo",
"selflink": "some URL",
"pnfs": {
"pnf" : [
{
"pnf-name": "name 1"
},
{
"pnf-name": "name 2"
}
]
},
"relationship-list": {
"relationship" : [
{
"related-to": "vpn-binding",
"related-link": "url of vpn-binding",
"relationship-data": [
"relationship-key": "vpn-binding.vpn-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-11 | termination-point Notes: See Figure 4 above. Update existing class of objects.
| aai_schema_v13.xsd - "p-interface"
- "vpn-bindings"
| add properties to existing "p-interface" object: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="PInterface">
<xml-root-element name="p-interface"/>
<java-attributes>
<xml-element name="network-ref" type="java.lang.String"/>
<xml-element name="transparent" type="java.lang.String"/>
<xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/pnfs/pnf/{pnfName}
/p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
"interface-name": "{tp-id}",
"network-ref": "some network",
"transparent": "some value",
"operational-status": "some oper",
"speed-value": "eth bandwidth",
"relationship-list": {
"relationship" : [
{
"related-to": "vpn-binding",
"related-link": "url of vpn-binding",
"relationship-data": [
"relationship-key": "vpn-binding.vpn-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-12 | cross-domain link Notes: See Figures 5, 6, 7, 8 and 9 above. Record information in AAI that crosses between ONAP Domain 1 and ONAP Domain 2 |
| new proposed elements "external-aai-list" and "external-aai": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="ExtAaiNetworks">
<xml-root-element name="ext-aai-networks" />
<java-attributes>
<xml-element name="ext-aai-network"
type="inventory.aai.onap.org.v14.ExtAaiNetwork" />
</java-attributes>
</java-type>
<java-type name="ExtAaiNetwork">
<xml-root-element name="ext-aai-network" />
<java-attributes>
<xml-element name="aai-id" type="java.lang.String"
required="true" xml-key="true">
<xml-element name="schema-version" type="java.lang.String">
<xml-element name="esr-system-info"
type="inventory.aai.onap.org.v14.EsrSystemInfo" />
<xml-element name="logical-links"
type="inventory.aai.onap.org.v14.LogicalLinks" />
<xml-element name="vpn-bindings"
type="inventory.aai.onap.org.v14.VpnBindings" />
<xml-element name="pnfs"
type="inventory.aai.onap.org.v14.Pnfs" />
<xml-element name="connectivities"
type="inventory.aai.onap.org.v14.Connectivities" />
<xml-element name="lan-port-configs"
type="inventory.aai.onap.org.v14.LanPortConfigs" />
<xml-element name="network-resources"
type="inventory.aai.onap.org.v14.NetworkResources" />
<xml-element name="site-resources"
type="inventory.aai.onap.org.v14.SiteResources" />
<xml-element name="sdwan-vpns"
type="inventory.aai.onap.org.v14.SdwanVpns"/>
<xml-element name="devices"
type="inventory.aai.onap.org.v14.Devices"/>
<xml-element name="wan-port-configs"
type="inventory.aai.onap.org.v14.WanPortConfigs" />
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/ext-aai-networks/ext-aai-network/{aaiId}
/p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
"aai-id-name": "{aaiId}",
"schema-version": "some version",
"esr-system-info": {
"esr-system-info-id": "some id",
"system-name": "some name"
}
}
|
|
AAI-1353-13 | SDWAN VPN Notes: See Figure 10 above. Proposal for specific new class of "sdwan-vpn" objects. | aai_schema_v13.xsd | new element "sdwan-vpn" and new element "sdwan-vpns": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="SdwanVpn">
<xml-root-element name="sdwan-vpn"/>
<java-attributes>
<xml-element name="sdwan-vpn-id" type="java.lang.String"/>
<xml-element name="sdwan-vpn-name" type="java.lang.String"/>
<xml-element name="vxlan-id" type="java.lang.String"/>
<xml-element name="topology" type="java.lang.String"/>
<xml-element name="tenant-id" type="java.lang.String"/>
<xml-element name="vpn-id" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
<xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="model-customization-id" type="java.lang.String"/>
<xml-element name="model-version- |
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
|
<java-type name="PortConfig">
<xml-root-element name="port-config"/>
<java-attributes>
<xml-element name="id" type="java.lang.String"/>
<xml-element name=" |
| config | typeid" type="java.lang.String"/>
<xml-element name=" |
| service | instancelist"
type="inventory.aai.onap.org.v14. |
| ServiceInstanceRelationshipList"/>
</java-attributes>
</java-type> |
|
| PortConfigsSdwanVpns">
<xml-root-element name=" |
| port | configsvpns"/>
<java-attributes>
<xml-element name=" |
| port | configvpn" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14. |
| PortConfigsSdwanVpn"/>
</java-attributes>
</java-type>
|
| xml | Schema (XSD) | true | <xs:element name="port-config">
<xs:complexType>
<xs:sequence>
<xs:element name="port-id" type="xs:string">
<xs:element name="config-type" type="xs:string">
<xs:element ref="tns:service-instance"
minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="port-configs">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:port-config"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element> |
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/sdwan-vpns/sdwan-vpn/{id}
Method: PUT
Request Body:
{
"sdwan-vpn-id": "{id}",
"sdwan-vpn-name": "a name",
"vxlan-id": "an id",
"topology": "topology value",
"tenant-id": "tenant value",
"vpn-id": "vpn value",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
|
| Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
|
URL: https://<AAI host>:<AAI port>/aai/v14/network
/port-configs/port-config/portId
Method: PUT
Request Body:
{
"port-id": "portId",
"config-type": "lan or wan",
"service-instance": {
| "service-instance-id" | : | "instance | id"
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
}
]
}
}
|
| AAI-1353-14 | SDWAN Device Notes: Proposal for specific new class of "device" objects.
|
| new element "device" and new element "devices": | }
}
AAI-1353-8 | site-resource Notes: See Figure 3 above. | new element "site-resource" and new element "site-resources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="SiteResource">
<xml-root-element name="site-resource"/>
<java-attributes>
<xml-element name="id" type="java.lang.String"/>
<xml-element name="name" type="java.lang.String"/>
<xml-element name="description" type="java.lang.String"/>
<xml-element name="type" type="java.lang.String"/>
<xml-element name="role" type="java.lang.String"/>
<xml-element name="p-location"
type="inventory.aai.onap.org.v14.PLocation"/>
</java-attributes>
</java-type>
<java-type name="SiteResources">
<xml-root-element name="site-resources"/>
<java-attributes>
<xml-element name="site-resource" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.SiteResource"/>
</java-attributes>
</java-type> Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSDOXM) |
---|
collapse | true |
---|
| <xs:<java-type name="Device">
<xml-root-element name="site-resourcedevice"/>
<xs:complexType><java-attributes>
<xml-element <xs:sequence>name="device-id" type="java.lang.String"/>
<xs:<xml-element name="idesn" type="xs:string"java.lang.String"/>
<xs:<xml-element name=""device-name" type="xs:string"java.lang.String"/>
<xs:<xml-element name="description" type="xs:string"java.lang.String"/>
<xs:<xml-element name="typevendor" type="xs:string"java.lang.String"/>
<xs:<xml-element name="roleclass" type="xs:string"java.lang.String"/>
<xs:<xml-element refname="tns:p-locationtype"
minOccurstype="1java.lang.String"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:<xml-element name="version" type="site-resources"java.lang.String"/>
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:site-resource"
minOccurs="0" maxOccurs="unbounded <xml-element name="system-ip" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
</xs:sequence>
</xs:complexType>
</xs:element> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/site-resources/site-resource/{id}
Method: PUT
Request Body:
{
"id": "{id}",
"name": "some name",
"description": "some description",
"type": "some type",
"role": "some role",
"p-location": {
"emails": "some email",
"address": "some address",
"postcode": "some postcode",
"latitude": "some latitude",
"longitude": "some longitude"
}
}
|
| AAI-1353-9 | p-location Notes: See Figure 3 above. | new element "p-location" and new element "p-locations", as sub-component of "site-resource": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="PLocation">
<xml-root-element name="p-location"/>
<java-attributes>
<xml-element name="emails" type="java.lang.String"/>
<xml-element name="postcode" type="java.lang.String"/>
<xml-element name="address" type="java.lang.String"/>
<xml-element name="latitude" type="java.lang.String"/>
<xml-element name="longitude" type="java.lang.String"/>
</java-attributes>
</java-type>
<java-type name="PLocations">
<xml-root-element name="p-locations"/>
<java-attributes>
<xml-element name="site-resource" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.PLocation"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="p-location">
<xs:complexType>
<xs:sequence>
<xs:element name="emails" type="xs:string">
<xs:element name="postcode" type="xs:string">
<xs:element name="address" type="xs:string">
<xs:element name="latitude" type="xs:string">
<xs:element name="longitude" type="xs:string">
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="p-locations">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:p-location"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element> |
| AAI-1353-10 | <xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="model-customization-id" type="java.lang.String"/>
<xml-element name="model-version-id" type="java.lang.String"/>
<xml-element name="model-invariant-id" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="Devices">
<xml-root-element name="devices"/>
<java-attributes>
<xml-element name="device" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.Device"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/devices/device/{id}
Method: PUT
Request Body:
{
"device-id": "{id}",
"esn": "an esn",
"device-name": "a name",
"description": "a description",
"vendor": "vendor value",
"class": "a class",
"type": "a type",
"version": "version value",
"system-ip": "ip value",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-15 | SDWAN Port Notes: Proposal for specific new class of "wan-port-config" objects. |
| new element "wan-port-config" and new element "wan-port-configs | topo-network
Notes:
See Figure 4 above.
Proposal for specific new class of "network-resource" objects.
aai_schema_v13.xsd - "pnfs"
- "p-interfaces"
- "vpn-bindings"
| new element "network-resource" and new element "network-resources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="networkResourceWanPortConfig">
<xml-root-element name="networkwan-port-resourceconfig"/>
<java-attributes>
<xml-element name="wan-port-config-id" type="java.lang.String"/>
<xml-element name="wan-port-config-name" type="java.lang.String"/>
<xml-element name="networkdevice-id" type="java.lang.String"/>
<xml-element name="providervlan-id" type="java.lang.String"/>
<xml-element name="client-idip-address" type="java.lang.String"/>
<xml-element name="provider-ip-address" type="java.lang.String"/>
<xml-element name="teinput-topo-idbandwidth" type="java.lang.String"/>
<xml-element name="pnfs"
output-bandwidth" type="inventoryjava.aai.onap.org.v14.Pnfslang.String"/>
<xml-element name="p-interfacesdescription"
type="inventoryjava.aai.onap.org.v14.PInterfaceslang.String"/>
<xml-element name="vpnport-bindingstype"
type="inventoryjava.aai.onap.org.v14.VpnBindingslang.String"/>
</java-attributes>
</java-type>
<java-type <xml-element name="networkResourcesport-number">
<xml-root-element name="network-resources type="java.lang.String"/>
<java-attributes>
<xml-element name="transport-network-resourcename" container-type="java.lang.ArrayListString"/>
<xml-element name="device-port-id" type="inventoryjava.aai.onap.org.v14.NetworkResourcelang.String"/>
</java-attributes>
</java-type> | Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:<xml-element name="network-resource">
<xs:complexType>
<xs:sequence>
<xs:element name="networkwan-port-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="provider-idselflink" type="xs:string"java.lang.String"/>
<xs:<xml-element name="clientoperational-idstatus" type="xs:string"java.lang.String"/>
<xs:<xml-element name="temodel-topocustomization-id" type="xs:string"java.lang.String"/>
<xs:<xml-element refname="tns:pnfs"
minOccurs="1" maxOccurs="unboundedmodel-version-id" type="java.lang.String"/>
<xs:element ref="tns:p-interfaces"
minOccurs="1" maxOccurs="unbounded<xml-element name="model-invariant-id" type="java.lang.String"/>
<xs:<xml-element refname="tns:vpnrelationship-bindingslist"
minOccurs="1" maxOccurs="unboundedtype="inventory.aai.onap.org.v14.RelationshipList"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:java-attributes>
</java-type>
<java-type name="WanPortConfigs">
<xml-root-element name="networkwan-port-resourcesconfigs"/>
<xs:complexType>
<xs:sequence><java-attributes>
<xs:<xml-element refname="tns:network-resource"
minOccurs="0" maxOccurs="unboundedwan-port-config" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.WanPortConfig"/>
</xs:sequence>
</xs:complexType>
</xs:element>java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/networkwan-port-resourcesconfigs/networkwan-port-resourceconfig/{networkIdid}
Method: PUT
Request Body:
{
"networkwan-port-config-id": "{networkIdid}",
"provider-idwan-port-config-name": "somea providername",
"clientdevice-id": "someid clientvalue",
"tevlan-topo-id": "somevlan topovalue",
"pnfsip-address": {
"ip value",
"pnfprovider-ip-address" : [
"provider {
ip value",
"pnfinput-namebandwidth": "namebandwidth 1value",
"output-bandwidth": }"bandwidth value",
"description": {
"a description",
"port-type": "type value",
"pnfport-namenumber": "namenumber 2value",
"transport-network-name": "name value",
"device-port-id": "id }value",
"wan-port-id": "id value",
]
"selflink": "some }URL",
"poperational-interfacesstatus": {
"some status",
"p-interface" : [
{"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"interfacerelationship-namelist": "name 1"{
"relationship" : },[
{
"interfacerelated-nameto": "name 2"service-instance",
}
"related-link": "url ]of service-instance",
},
"vpn-bindings": {
"vpnrelationship-bindingdata" : [
{
"vpn-id"relationship-key": "vpn id 1"service-instance.service-instance-id",
},
"relationship-value": {"some id"
"vpn-id": "vpn id 2"]
}
]
}
}
|
|
AAI-1353-1116 | pnf termination-point Notes: See Figure 4 above. Update existing class of objects. | aai_schema_v13.xsd - "p-interface""vpn-bindingspnf"
| add properties to existing "pnf" object: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true | true |
---|
| <java-type name="Pnf">
<xml-root<java-type name="PInterface">
<xml-root-element name="p-interface"/>
<java-attributes>
<xml-element name="network-ref" type="java.lang.String"/>
<xml-element name="transparent" type="java.lang.String"pnf"/>
<java-attributes>
<xml-element name="vpn-bindings"
type="inventory.aai.onap.org.v14.VpnBindings"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="p-interface">
<xs:complexType>
<xs:sequence>
<xs:admin-status" type="java.lang.String"/>
<xml-element name="networkoperational-refstatus" type="xs:string"java.lang.String"/>
<xs:<xml-element name="transparentmodel-customization-id" type="xs:string"java.lang.String"/>
<xs:<xml-element refname="tns:vpn-bindings"model-version-id" type="java.lang.String"/>
minOccurs="0" maxOccurs="unbounded<xml-element name="model-invariant-id" type="java.lang.String"/>
</xs:sequence>
</xs:complexType>
</xs:element>java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/pnfs/pnf/{pnfName}
/p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
"interface-name": "{tp-id}",
"network-ref": "some network",
"transparent": "some value",
"speed-value": "eth bandwidth", Body:
{
"vpninterface-bindingsname": "{
tp-id}",
"vpnadmin-bindingstatus" : [
{
"some admin",
"vpnoperational-idstatus": "vpnsome id 1"
},
{
status",
"vpnmodel-customization-id": "vpnsome id 2customization",
"model-version-id": }"some version",
"model-invariant-id": ]
}
}
|
| AAI-1353-12 | cross-domain link
Notes:
See Figure 5 and Figure 6 and Figure 7 above.
Record information in AAI that crosses between ONAP Domain 1 and ONAP Domain 2 tbc | AAI-1353-999 | SDWAN-service | tbc |