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"/>
<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-resourcesconfigs"
type="inventory.aai.onap.org.v14.PortResourcesWanPortConfigs"/>
<xml-element name="ext-aai-networks"
type="inventory.aai.onap.org.v14.ExtAaiNetworks"/>
</java-attributes>
</java-type>
<java-type name="Business">
<xml-root-element name="business"/>
<java-attributes>
<xml-element name="sp-partners"
type="inventory.aai.onap.org.v14.SpPartners"/>
</java-attributes>
</java-type>
|
|
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 | 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. | aai_schema_v13.xsd - "service-instance"
- "vpn-bindings"
| new element "connectivity" 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="connectivity-id" type="java.lang.String"/>
<xml-element name="bandwidth-profile-name" type="java.lang.String"/>
<xml-element name="vpn-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="etht-svc-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="connectivity-selflink" type="java.lang.String"/>
<xml-element name="cvlan" type="java.lang.String"/>
<xml-element name="relationshipoperational-liststatus"
type="inventoryjava.aai.onap.org.v14.RelationshipListlang.String"/>
</java-attributes>
</java-type>
<java-type<xml-element name="Connectivities">
<xml-root-element name="connectivitiesmodel-customization-id" type="java.lang.String"/>
<java-attributes>
<xml-element name="connectivitymodel-version-id" container-type="java.lang.ArrayListString"/>
<xml-element name="model-invariant-id" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.ConnectivityRelationshipList"/>
</java-attributes>
</java-type>
<java-type name="Connectivities">
<xml-root-element name="connectivities"/>
<java-attributes>
<xml-element name="connectivity" container-type="java.lang.ArrayList"
type="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:
{
| 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",
"CIRcir": "cir value",
"EIReir": "eir value",
"CBScbs": "cbs value",
"EBSebs": "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",
"related-link": "url of vpn-binding",
"relationship-data": [
"relationship-key": "vpn-binding.vpn-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
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>
<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"/>
</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:
{
"vpn-id": "vpnId",
"vpn-name": "vpn name",
"access-provider-id": "provider id",
"access-client-id": "client id",
"access-topology-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"
}
,
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant"
}
|
|
AAI-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="is-local-created" type="java.lang.String"/>
<xml-element name="callsource" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</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 | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/business
/sp-partners/sp-partner/partnerId
Method: PUT
Request Body:
{
"sp-partner-id": "partnerId",
"url": "partner url",
"is-local-created"callsource": "some value",
"callsource": "some source",
"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-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" type="java.lang.String"/>
<xml-element name="vpn-name" type="java.lang.String"/>
</java-attributes>
</java-type>
|
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}
/allotted-resources/allotted-resource/{id}
Method: PUT
Request Body:
{
"allotted-resource-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",
"cvlan": "some tag",
"vpn-name": "some name"
}
|
|
AAI-1353-7 | LAN port configWAN 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": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="PortConfigLanPortConfig">
<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-typename" type="java.lang.String"/>
<xml-element name="relationship-list"
description" type="inventoryjava.aai.onap.org.v14.RelationshipListlang.String"/>
</java-attributes>
</java-type>
<java-type name="PortConfigs">
<xml-root<xml-element name="device-id" type="java.lang.String"/>
<xml-element name="port-configs"/>
<java-attributes>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="port-config" container-input-bandwidth" type="java.lang.String"/>
<xml-element name="output-bandwidth" type="java.lang.ArrayList"String"/>
<xml-element name="dhcp-services"
type="inventory.aai.onap.org.v14.PortConfigsDhcpServices"/>
</java-attributes>
</java-type> <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": {
| 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",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationshipdhcp-dataservice": [
{
"relationshipservice-keyenable": "service-instance.service-instance-idsome enable",
"dhcp-service-type": "some service",
"relationshiplease-valuetime": "some idtime",
"domain-name": "some ]
domain",
}
"dns": "some dns",
]
}
}
|
| 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="generated-site-id" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
<xml-element name="p-location"
type="inventory.aai.onap.org.v14.PLocation"/>
<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:
{
"id": "{id}",
"name": "some name",
"description": "some description",
"type": "some type",
"role": "some role",
"generated-site-id"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",
"selflink": "some URL",
"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"
]
}
]
},
"p-location": {
"location-name": "some name",
"emails": "some email",
"address": "some address",
"postcode": "some postcode",
"latitude": "some latitude",
"longitude": "some longitude"
}
}
}
}
|
|
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 | AAI-1353-9 | p-location Notes: See Figure 3 above. |
| new element "psite-locationresource" and new element "p-locations", as sub-component of "site-resourceresources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="PLocationSiteResource">
<xml-root-element name="psite-locationresource"/>
<java-attributes>
<xml-element name="locationsite-nameresource-id" type="java.lang.String"/>
<xml-element name="emailssite-resource-name" type="java.lang.String"/>
<xml-element name="postcodedescription" type="java.lang.String"/>
<xml-element name="addresstype" type="java.lang.String"/>
<xml-element name="latituderole" type="java.lang.String"/>
<xml-element name="longitudegenerated-site-id" type="java.lang.String"/>
</java-attributes>
</java-type>
<java-type<xml-element name="PLocations""selflink" type="java.lang.String"/>
<xml-root-element name="p-locationsoperational-status" type="java.lang.String"/>
<java-attributes>
<xml-element name="pmodel-customization-locationid" container-type="java.lang.ArrayListString"/>
<xml-element name="model-version-id" type="inventoryjava.aai.onap.org.v14.PLocationlang.String"/>
</java-attributes>
</java-type> |
| 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 |
---|
| <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="networkResourceSiteResources">
<xml-root-element name="networksite-resourceresources"/>
<java-attributes>
<xml-element name="networksite-idresource" container-type="java.lang.StringArrayList"/>
<xml-element name="provider-id" type="javainventory.aai.lang.String"/>
<xml-element name="client-id" type="java.lang.Stringonap.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="te-topo-id" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
<xml-element name="pnfs"
network-ref" type="inventoryjava.aai.onap.org.v14.Pnfslang.String"/>
<xml-element name="relationship-listtransparent"
type="inventoryjava.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="networkResources">
<xml-root-element name="network-resources"/>
<java-attributes>lang.String"/>
<xml-element name="networkoperational-resourcestatus" container-type="java.lang.ArrayList"String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.NetworkResourceRelationshipList"/>
</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"
},
{
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": {
"pnf-namerelationship" : "name 2"[
}{
]
},
"relationshiprelated-listto": {"vpn-binding",
"relationship" : [
"related-link": "url {of vpn-binding",
"relatedrelationship-todata": "vpn-binding",[
"relatedrelationship-linkkey": "url of vpn-binding.vpn-id",
"relationship-datavalue": "some [id"
]
"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"
]
}
}
|
| 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 |
---|
| type="inventory.aai.onap.org.v14.ExtAaiNetwork" />
</java-attributes>
</java-type>
<java-type name="PInterfaceExtAaiNetwork">
<xml-root-element name="pext-aai-interfacenetwork" />
<java-attributes>
<xml-element name="network-ref" type="java.lang.String"/aai-id" type="java.lang.String"
required="true" xml-key="true">
<xml-element name="transparentschema-version" type="java.lang.String"/>
<xml-element name="relationshipesr-system-listinfo"
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",
"speed-value": "eth bandwidth",
"relationship-list": {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"
"relationship" : [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"
"related-to": "vpn-binding",type="inventory.aai.onap.org.v14.NetworkResources" />
<xml-element name="site-resources"
type="inventory.aai.onap.org.v14.SiteResources" />
"related-link": "url of vpn-binding",<xml-element name="sdwan-vpns"
type="inventory.aai.onap.org.v14.SdwanVpns"/>
<xml-element name="devices"
"relationship-data": [type="inventory.aai.onap.org.v14.Devices"/>
<xml-element name="wan-port-configs"
"relationship-key": "vpn-binding.vpn-id",
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}",
"relationshipschema-valueversion": "some idversion",
"esr-system-info": {
"esr-system-info-id": ]"some id",
"system-name": }
"some name"
]
}
}
|
|
AAI-1353- | 12cross-domain link13 | SDWAN VPN Notes: See | Figures 5, 6, 7, 8 and 9 above.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 | 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 | | ext | aai-networks | | <java-attributes>
<xml-element name="sdwan-vpn-id" type="java.lang.String"/>
<xml-element name=" |
| ext | aai-network"vpn-name" type="java.lang.String"/>
<xml-element |
| | inventory.aai.onap.org.v14.ExtAaiNetwork" java.lang.String"/>
<xml-element |
| </java-attributes>
</java-type>
<java-type name="ExtAaiNetwork"name="topology" type="java.lang.String"/>
<xml- |
| root- | ext | aai-networkid" type="java.lang.String"/> |
|
<java-attributes> | | aaivpn-id" type="java.lang.String"/>
|
| required | true | xml-key | true | | schema | versionstatus" type="java.lang.String"/>
|
| | esr | system | info |
| | inventory.aai.onap.org.v14.EsrSystemInfo" | | logical | links |
| | inventory | aai.onap.org.v14.LogicalLinks" | | vpn | bindings |
| | inventory | aai.onap.org.v14.VpnBindings" | | pnfs | type="inventory.aai.onap.org.v14. |
| Pnfs | />
<xml-element</java-attributes>
</java-type>
<java-type name=" |
| connectivities | type="inventory.aai.onap.org.v14.Connectivities" <xml-root-element name="sdwan-vpns"/>
|
| <java-attributes>
<xml-element name=" |
| port-configs"
sdwan-vpn" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14. |
| PortConfigs | | <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="port-resources"
type="inventory.aai.onap.org.v14.PortResources" />
</java-attributes>
</java-type>
Code Block |
---|
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": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="WanPortConfig">
<xml-root-element name="wan-port-config"/>
<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="device-id" type="java.lang.String"/>
<xml-element name="vlan-id" type="java.lang.String"/>
<xml-element name="ip-address" type="java.lang.String"/>
<xml-element name="provider-ip-address" 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="description" type="java.lang.String"/>
<xml-element name="port-type" type="java.lang.String"/>
<xml-element name="port-number" type="java.lang.String"/>
<xml-element name="transport-network-name" type="java.lang.String"/>
<xml-element name="device-port-id" type="java.lang.String"/>
<xml-element name="wan-port-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- |
| "/>
</java-attributes>
</java-type>
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
|
URL: https://<AAI host>:<AAI port>/aai/v14/network
/sdwan-vpns/sdwan-vpn/{id}
Method: PUT
Request Body:
{
"id": "{id}",
"name": "a name",
"vxlan-id": "an id",
"topology": "topology value",
"tenant-id": "tenant value",
"vpn-id": "vpn value",
"selflink": "some URL",
"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-14 | SDWAN Device
Notes:
Proposal for specific new class of "device" objects.
new element "device" and new element "devices": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="Device">
<xml-root-element name="device"/>
<java-attributes>
<xml-element name="id" type="java.lang.String"/>
<xml-element name="esn" type="java.lang.String"/>
<xml-element name="name" type="java.lang.String"/>
<xml-element name="description" type="java.lang.String"/>
<xml-element name="vendor" type="java.lang.String"/>
<xml-element name="class" type="java.lang.String"/>
<xml-element name="type" type="java.lang.String"/>
<xml-element name="version" type="java.lang.String"/>
<xml-element name="system-ip" type="java.lang.String"/>
<xml-element name="device-id" type="java.lang.String"/>
<xml-element name="selflink" 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:
{
"id": "{id}",
"esn": "an esn",
"name": "a name",
"description": "a description",
"vendor": "vendor value",
"class": "a class",
"type": "a type",
"version": "version value",
"system-ip": "ip value",
"device-id": "id value",
"selflink": "some URL",
"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 "port-resource" objects. | new element "port-resource" and new element "port-resources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="PortResource">
<xml-root-element name="port-resource"/>
<java-attributes>
<xml-element name="id" type="java.lang.String"/>
<xml-element name="name" relationship-list"
type="java.lang.String"/>inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="WanPortConfigs">
<xml-root-element name="wan-port-configs"/>
<java-attributes>
<xml-element name="devicewan-port-idconfig" container-type="java.lang.StringArrayList"/>
<xml-element name="vlan-id" type="java.lang.String"/>
<xml-element name="ip-address" type="java.lang.String"/>
<xml-element name="provider-ip-address" 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="description" type="java.lang.String"/>
<xml-element name="port-type" type="java.lang.String"/>
<xml-element name="port-number" type="java.lang.String"/>
<xml-element name="transport-network-name" type="java.lang.String"/>
<xml-element name="device-port-id" type="java.lang.String"/>
<xml-element name="wan-port-id" type="java.lang.String"/>
<xml-element name="selflink" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="PortResources">
<xml-root-element name="port-resources"/>
<java-attributes>
<xml-element name="device" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.PortResource"/>
</java-attributes>
</java-type>
inventory.aai.onap.org.v14.WanPortConfig"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/wan-port-configs/wan-port-config/{id}
Method: PUT
Request Body:
{
"wan-port-config-id": "{id}",
"wan-port-config-name": "a name",
"device-id": "id value",
"vlan-id": "vlan value",
"ip-address": "ip value",
"provider-ip-address": "provider ip value",
"input-bandwidth": "bandwidth value",
"output-bandwidth": "bandwidth value",
"description": "a description",
"port-type": "type value",
"port-number": "number value",
"transport-network-name": "name value",
"device-port-id": "id value",
"wan-port-id": "id value",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version | Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/port-resources/port-resource/{id}
Method: PUT
Request Body:
{
"id": "{id}",
"name": "a name",
"devicemodel-invariant-id": "idsome valueinvariant",
"vlanrelationship-idlist": {
"vlan value", "relationship" : [
{
"ip-address "related-to": "ip valueservice-instance",
"provider-ip-address": "provider ip value",
"inputrelated-bandwidthlink": "bandwidth valueurl of service-instance",
"output-bandwidth": "bandwidth value",
"description": "a description",
"portrelationship-typedata": "type value",
[
"port-number": "number value",
"transportrelationship-network-namekey": "name value",
service-instance.service-instance-id",
"device-port-id": "id value",
"wan-port-id": "id value",
"selflinkrelationship-value": "some URLid",
"relationship-list": {
"relationship" : []
{}
]
}
}
|
|