...
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
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:
| ||||||||||||||||||||||||||||||||||
AAI-1353-2 | SOTN Infra Closed Loop Site Service Instance Notes: See Figure 2 above. Use existing class of objects. Closed loop scenario:
| aai_schema_v13.xsd
| add properties to existing "service-instance" object:
| |||||||||||||||||||||||||||||||||
AAI-1353-3 | SOTN Connectivity Notes: See Figure 2 above. Proposal for specific new class of "connectivity" objects. | aai_schema_v13.xsd
| new element "connectivity" and new element "connectivities":
| |||||||||||||||||||||||||||||||||
AAI-1353-4 | VPN Notes: See Figure 2 above. Update existing class of objects. | aai_schema_v13.xsd
| add properties to existing "vpn-binding" object:
| AAI-1353-5 | SP Partner Notes: See Figure 2 above. Proposal for specific new class of "sp-partner"
| |||||||||||||||||||||||||||||||
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":
| |||||||||||||||||||||||||||||||||
AAI-1353-6 | SOTN Attachment Notes: See Figure 3 above. Update existing class of objects. | aai_schema_v13.xsd
| add properties to existing "allotted-resource" object:
| |||||||||||||||||||||||||||||||||
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":
| AAI-1353-7b | dhcp-service |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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"/>
</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> |
site-resource
Notes:
See Figure 3 above.
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
}
]
}
}
|
new element "dhcp-service" and new element "dhcp-services", as sub-component of "lan-port-config":
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<java-type name="SiteResourceDhcpService"> <xml-root-element name="sitedhcp-resourceservice"/> <java-attributes> <xml-element name="idservice-enable" type="java.lang.String"/> <xml-element name="namedhcp-service-type" type="java.lang.String"/> <xml-element name="descriptionlease-time" type="java.lang.String"/> <xml-element name="typedomain-name" type="java.lang.String"/> <xml-element name="roledns" type="java.lang.String"/> <xml-element name="generatedntp-site-idprimary" type="java.lang.String"/> <xml-element name="selflinkntp-secondary" type="java.lang.String"/> <xml-element name="p-location" nbns" type="inventoryjava.aai.onap.org.v14.PLocationlang.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="SiteResourcesDhcpServices"> <xml-root-element name="sitedhcp-resourcesservices"/> <java-attributes> <xml-element name="sitedhcp-resourceservice" container-type="java.lang.ArrayList" type="inventory.aai.onap.org.v14.SiteResourceDhcpService"/> </java-attributes> </java-type> |
site-resource
Notes:
See Figure 3 above.
new element "site-resource" and new element "site-resources":
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
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", <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": "some id",type="java.lang.String"/> <xml-element name="selflink": "some URL",type="java.lang.String"/> <xml-element name="relationshipoperational-liststatus": { type="java.lang.String"/> <xml-element name="model-customization-id" type="java.lang.String"/> <xml-element "relationship" : [name="model-version-id" type="java.lang.String"/> <xml-element name="model-invariant-id" type="java.lang.String"/> <xml-element name="relationship-list" { "related-to": "service-instance", 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
URL: https://<AAI host>:<AAI port>/aai/v14/network /site-resources/site-resource/{id} Method: PUT Request Body: { "relatedsite-resource-linkid": "url of service-instance{id}", "site-resource-name": "some name", "relationship-data"description": ["some description", "type": "some type", "role": "some role", "relationshipgenerated-site-keyid": "service-instance.service-instance-some id", "selflink": "some URL", "operational-status": "some status", "relationshipmodel-customization-valueid": "some idcustomization", "model-version-id": "some version", "model-invariant-id": "some invariant", ] "relationship-list": { }"relationship" : [ ] { }, "p-location": { "locationrelated-nameto": "some nameservice-instance", "emails "related-link": "some email",url of service-instance", "addressrelationship-data": "some address", [ "postcoderelationship-key": "some postcodeservice-instance.service-instance-id", "latitude": "some latitude", "longituderelationship-value": "some longitudeid" } } |
p-location
Notes:
See Figure 3 above.
new element "p-location" and new element "p-locations", as sub-component of "site-resource":
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<java-type name="PLocation"> <xml-root-element name="p-location"/> <java-attributes> <xml-element name="location-name" type="java.lang.String"/> <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="p-location" container-type="java.lang.ArrayList" type="inventory.aai.onap.org.v14.PLocation"/> </java-attributes> </java-type> ] }, { "related-to": "complex", "related-link": "url of complex", "relationship-data": [ "relationship-key": "complex.physical-location-id", "relationship-value": "some id" ] } ] } } |
physical location
Notes:
See Figure 3 above.
aai_schema_v13.xsd
- "complex"
use existing element "complex" to represent "physical location".
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<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 | ||||||
---|---|---|---|---|---|---|
| ||||||
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" ] } ] } } |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<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="operoperational-status" type="java.lang.String"/> <xml-element name="relationship-list" type="inventory.aai.onap.org.v14.RelationshipList"/> </java-attributes> </java-type> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
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", "operoperational-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" ] } ] } } |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<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 | ||||||
---|---|---|---|---|---|---|
| ||||||
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" } } |
SDWAN VPN
Notes:
See Figure 10 above.
Proposal for specific new class of "sdwan-vpn" objects.
aai_schema_v13.xsd
- "service-instance"
new element "sdwan-vpn" and new element "sdwan-vpns":
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<java-type name="SdwanVpn"> <xml-root-element name="sdwan-vpn-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"/> <java-attributes> <xml-element name="tenant-id" type="java.lang.String"/> <xml-element name="namevpn-id" type="java.lang.String"/> <xml-element name="vxlan-idselflink" type="java.lang.String"/> <xml-element name="topologyoperational-status" type="java.lang.String"/> <xml-element name="tenantmodel-customization-id" type="java.lang.String"/> <xml-element name="vpnmodel-version-id" type="java.lang.String"/> <xml-element name="selflinkmodel-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="SdwanVpns"> <xml-root-element name="sdwan-vpns"/> <java-attributes> <xml-element name="sdwan-vpn" container-type="java.lang.ArrayList" type="inventory.aai.onap.org.v14.SdwanVpn"/> </java-attributes> </java-type> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
URL: https://<AAI host>:<AAI port>/aai/v14/network /sdwan-vpns/sdwan-vpn/{id} Method: PUT Request Body: { "sdwan-vpn-id": "{id}id}", "sdwan-vpn-name": "a name", "vxlan-id": "an id", "topology": "topology value", "tenant-id": "tenant value", "namevpn-id": "avpn namevalue", "vxlan-idselflink": "ansome idURL", "topologyoperational-status": "topologysome valuestatus", "tenantmodel-customization-id": "tenantsome valuecustomization", "vpnmodel-version-id": "vpnsome valueversion", "selflinkmodel-invariant-id": "some URLinvariant", "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" ] } ] } } |
SDWAN Device
Notes:
Proposal for specific new class of "device" objects.
new element "device" and new element "devices":
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<java-type name="Device"> <xml-root-element name="device"/> <java-type name="Device">attributes> <xml-element name="device-id" type="java.lang.String"/> <xml-element name="esn" type="java.lang.String"/> <xml-root-element name="device-name" type="java.lang.String"/> <java-attributes> <xml-element name="iddescription" type="java.lang.String"/> <xml-element name="esnvendor" type="java.lang.String"/> <xml-element name="nameclass" type="java.lang.String"/> <xml-element name="descriptiontype" type="java.lang.String"/> <xml-element name="vendorversion" type="java.lang.String"/> <xml-element name="classsystem-ip" type="java.lang.String"/> <xml-element name="typeselflink" type="java.lang.String"/> <xml-element name="versionoperational-status" type="java.lang.String"/> <xml-element name="systemmodel-customization-ipid" type="java.lang.String"/> <xml-element name="devicemodel-version-id" type="java.lang.String"/> <xml-element name="selflinkmodel-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 | ||||||
---|---|---|---|---|---|---|
| ||||||
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", "esnvendor": "anvendor esnvalue", "nameclass": "a nameclass", "descriptiontype": "a descriptiontype", "vendorversion": "vendorversion value", "classsystem-ip": "aip classvalue", "typeselflink": "asome typeURL", "versionoperational-status": "versionsome valuestatus", "systemmodel-customization-ipid": "ipsome valuecustomization", "devicemodel-version-id": "idsome valueversion", "selflinkmodel-invariant-id": "some URLinvariant", "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" ] } ] } } |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<java-type name="WanPortConfig"> <xml-root-type name="WanPortConfig">element name="wan-port-config"/> <java-attributes> <xml-element name="wan-port-config-id" type="java.lang.String"/> <xml-root-element name="wan-port-config-name" type="java.lang.String"/> <java-attributes><xml-element name="device-id" type="java.lang.String"/> <xml-element name="vlan-id" type="java.lang.String"/> <xml-element name="nameip-address" type="java.lang.String"/> <xml-element name="deviceprovider-ip-idaddress" type="java.lang.String"/> <xml-element name="vlaninput-idbandwidth" type="java.lang.String"/> <xml-element name="ipoutput-addressbandwidth" type="java.lang.String"/> <xml-element name="description" type="provider-ip-address"java.lang.String"/> <xml-element name="port-type" type="java.lang.String"/> <xml-element name="inputport-bandwidthnumber" type="java.lang.String"/> <xml-element name="outputtransport-network-bandwidthname" type="java.lang.String"/> <xml-element name="descriptiondevice-port-id" type="java.lang.String"/> <xml-element name="wan-port-typeid" type="java.lang.String"/> <xml-element name="port-numberselflink" type="java.lang.String"/> <xml-element name="transportoperational-network-namestatus" type="java.lang.String"/> <xml-element name="devicemodel-portcustomization-id" type="java.lang.String"/> <xml-element name="wanmodel-portversion-id" type="java.lang.String"/> <xml-element name="selflinkmodel-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="WanPortConfigs"> <xml-root-element name="wan-port-configs"/> <java-attributes> <xml-element name="devicewan-port-config" container-type="java.lang.ArrayList" type="inventory.aai.onap.org.v14.WanPortConfig"/> </java-attributes> </java-type> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
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 description", "port-type": "type value", "port-number": "number value", "transport-network-name": "name value", "device-port-id": "id value", "wan-port-typeid": "typeid value", "port-numberselflink": "numbersome valueURL", "transportoperational-network-namestatus": "namesome valuestatus", "devicemodel-portcustomization-id": "idsome valuecustomization", "wanmodel-portversion-id": "idsome valueversion", "selflinkmodel-invariant-id": "some URLinvariant", "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_schema_v13.xsd
- "pnf"
add properties to existing "pnf" object:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<java-type name="Pnf"> <xml-root<java-type name="Pnf"> <xml-root-element name="pnf"/> <java-attributes> <xml-element name="admin-status" type="java.lang.String"/> <xml-element name="operational-status" type="java.lang.String"/> <xml-element name="pnf"model-customization-id" type="java.lang.String"/> <java-attributes> <xml-element name="opermodel-version-statusid" type="java.lang.String"/> <xml-element name="adminmodel-invariant-statusid" type="java.lang.String"/> </java-attributes> </java-type> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
URL: https://<AAI host>:<AAI port>/aai/v14/network /pnfs/pnf/{pnfName} Method: PUT Request Body: { "interface-name": "{tp-id}", "operadmin-status": "some operadmin", "admin-statusoperational-status": "some status", "model-customization-id": "some admin customization", "model-version-id": "some version", "model-invariant-id": "some invariant", } |