Page History

...

VPN

Notes:

See Figure 2 above.

Update existing class of objects.

SP Partner

Notes:

See Figure 2 above.

Proposal for specific new class of "sp-partner" objects.

SOTN Attachment

Notes:

See Figure 3 above.

Update existing class of objects.

add properties to existing object:

Reference Id

CCVPN Use Case Reference

AAI Schema Reference

AAI Proposed Schema

AAI-1353-1

aai_schema_v13.xsd

"network"
"business"

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="port-configs"
   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="extsdwan-aai-networksvpns"
   type="inventory.aai.onap.org.v14.ExtAaiNetworksSdwanVpns"/>
  <xml-element name="sdwan-vpnsdevices"
   type="inventory.aai.onap.org.v14.SdwanVpnsDevices"/>
  <xml-element name="devicesport-resources"
   type="inventory.aai.onap.org.v14.DevicesPortResources"/>
  <xml-element name="portext-aai-resourcesnetworks"
   type="inventory.aai.onap.org.v14.PortResourcesExtAaiNetworks"/>
 </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>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="network">
 <xs:complexType>
   <xs:sequence>
    <xs:element ref="tns:connectivities"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:port-configs"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:network-resources"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:site-resources"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:ext-aai-networks"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:devices"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:sdwan-vpns"
     minOccurs="0" maxOccurs="unbounded"/>
    <xs:element ref="tns:port-resources"
     minOccurs="0" maxOccurs="unbounded"/>
   </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>

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 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="customer-requests" 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",
    customer-requests: "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", 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="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="CIR" type="java.lang.String"/>
  <xml-element name="EIR" type="java.lang.String"/>
  <xml-element name="CBS" type="java.lang.String"/>
  <xml-element name="EBS" 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="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </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	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="connectivity">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="connectivity-id" type="xs:string" minOccurs="1">
    <xs:element name="bandwidth-profile-name" type="xs:string">
    <xs:element name="vpn-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="etht-svc-name" 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 name="connectivity-selflink" type="xs:string">
    <xs:element name="cvlan" type="xs:string">
    <xs:element ref="tns:relationship-list"
     minOccurs="0" maxOccurs="1"/>
   </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>

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",
    "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-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="customer-requests" 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",
    customer-requests: "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="CIR" type="java.lang.String"/>
  <xml-element name="EIR" type="java.lang.String"/>
  <xml-element name="CBS" type="java.lang.String"/>
  <xml-element name="EBS" 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="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </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:
{
    "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",
    "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

AAI-1353-4

aai_schema_v13.xsd

"vpn-binding"
"vpn-bindings"

add properties to existing 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: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="src-access-node-id" type="xs:string">
    <xs:element name="src-access-ltp-id" type="xs:string">
    <xs:element name="dst-access-node-id" type="xs:string">
    <xs:element name="dst-access-ltp-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:
{
    "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"
}

AAI-1353-5

aai_schema_v13.xsd

"service-instances"

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="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	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="sp-partner">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="id" type="xs:string">
    <xs:element name="url" type="xs:string">
    <xs:element name="is-local-created" type="xs:string">
    <xs:element name="callsource" type="xs:string">
    <xs:element ref="tns:relationship-list"
     minOccurs="0" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:element name="sp-partners">
 <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:
{
    "id": "partnerId",
    "url": "partner url",
    "is-local-created": "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

aai_schema_v13.xsd

"allotted-resource"
"allotted-resources"

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="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	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="allotted-resource">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="name" 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 name="cvlan" type="xs:string">
    <xs:element name="vpn-name" 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}
 /allotted-resources/allotted-resource/{id}
Method: PUT
Request Body:
{
    "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 config

WAN port config

Notes:

See Figure 3 above.

Proposal for specific new class of "port-config" objects.

aai_schema_v13.xsd

"service-instances"

new element "port-config" and new element "port-configs":

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-type" type="java.lang.String"/>
  <xml-element name="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </java-attributes>
</java-type>


<java-type name="PortConfigs">
 <xml-root-element name="portvpn-configsbinding"/>
 <java-attributes>
  <xml-element name="portaccess-provider-configid" container-type="java.lang.ArrayListString"/>
  <xml-element typename="inventory.aai.onap.org.v14.PortConfigs"/>
 </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="port-config">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="portaccess-client-id" type="java.lang.String"/>
  <xml-element name="access-topology-id" type="java.lang.String"/>
  <xml-element name="access-node-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="configaccess-ltp-typeid" type="xs:string"java.lang.String"/>
    <xs:<xml-element refname="tns:relationship-list"src-access-node-id" type="java.lang.String"/>
     minOccurs="0" maxOccurs="1<xml-element name="src-access-ltp-id" type="java.lang.String"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:<xml-element name="port-configs">
 <xs:complexType>
   <xs:sequence>
    <xs:element ref="tns:port-config"
     minOccurs="0" maxOccurs="unboundeddst-access-node-id" type="java.lang.String"/>
  <xml-element name="dst-access-ltp-id" type="java.lang.String"/>
   </xs:sequence>
 </xs:complexType>java-attributes>
</xs:element>java-type>

Code Block

language	js
title	Mockup API
collapse	true

URL: https://<AAI host>:<AAI port>/aai/v14/network
 /portvpn-configsbindings/portvpn-configbinding/portId
Method: PUT
Request Body:
{
    "port-id": "portId",
    "config-type": "lan or wan",
    "relationship-list": {
        "relationship" : [
            {
           vpnId
Method: PUT
Request Body:
{
     "relatedvpn-toid": "service-instancevpnId",
                "relatedvpn-linkname": "url of service-instancevpn name",
                "relationship-data": [
             "access-provider-id": "provider id",
       "relationship-key"access-client-id": "service-instance.service-instance-client id",
                    "relationship-value"access-topology-id": "sometopology 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"
}
}

AAI-1353-85

SP Partnersite-resource

Notes:

See Figure 3 above.

See Figure 2 above.

Proposal for specific new class of "sp-partner" objects.

aai_schema_v13.xsd

"service-instances"

new element "sitesp-resourcepartner" and new element "sitesp-resourcespartners":

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="SiteResourceSpPartner">
 <xml-root-element name="sitesp-resourcepartner"/>
 <java-attributes>
  <xml-element name="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="descriptioncallsource" type="java.lang.String"/>
  <xml.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="type" type="java.lang.Stringsp-partners"/>
 <java-attributes>
  <xml-element name="role"sp-partner"
   type="java.lang.Stringinventory.aai.onap.org.v14.SpPartner"/>
  <xml-element name="generated-site-id" type="java.lang.String"/>
  <xml-element name="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
  <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 (XSD)
collapse	true

<xs:element name="site-resource">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="id" type="xs:string">
    <xs:element name="name" type="xs:string">
    <xs:element name="description" type="xs:string">
    <xs:element name="type" type="xs:string">
    <xs:element name="role" type="xs:string">
    <xs:element name="generated-site-id" type="xs:string">
    <xs:element ref="tns:relationship-list"
     minOccurs="0" maxOccurs="1"/>
    <xs:element ref="tns:p-location"
     minOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:element name="site-resources">
 <xs:complexType>
   <xs:sequence>
    <xs:element ref="tns:site-resource"
     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/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": "some id",
    "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"
    }
}

</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:
{
    "id": "partnerId",
    "url": "partner url",
    "is-local-created": "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="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:
{
    "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 config

WAN port config

Notes:

See Figure 3 above.

Proposal for specific new class of "port-config" objects.

aai_schema_v13.xsd

"service-instances"

new element "port-config" and new element "port-configs

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="PLocationPortConfig">
 <xml-root-element name="pport-locationconfig"/>
 <java-attributes>
  <xml-element name="location-nameid" type="java.lang.String"/>
  <xml-element name="emails" type="java.lang.String"/>
  <xml-element name="postcode" type="java.lang.String"/>
  <xml-element name="address" config-type" type="java.lang.String"/>
  <xml-element name="latitude" type="java.lang.String"/>
  <xml-element name="longitude"relationship-list" 
   type="java.lang.Stringinventory.aai.onap.org.v14.RelationshipList"/>
 </java-attributes>
</java-type>


<java-type name="PLocationsPortConfigs">
 <xml-root-element name="pport-locationsconfigs"/>
 <java-attributes>
  <xml-element name="pport-locationconfig" container-type="java.lang.ArrayList"
   type="inventory.aai.onap.org.v14.PLocationPortConfigs"/>
 </java-attributes>
</java-type>

Code Block

language	xmljs
title	Mockup Schema (XSD)API
collapse	true

<xsURL:element name="p-location">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="location-name" type="xs:string" minOccurs=1>
    <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

topo-network

Notes:

See Figure 4 above.

Proposal for specific new class of "network-resource" objects.

 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",
                "relationship-data": [
                    "relationship-key": "service-instance.service-instance-id",
                    "relationship-value": "some id"
                ]
            }
        ]
    }
}

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

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="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="networksite-resourcesresource"/>
 <java-attributes>
  <xml-element name="network-resourceid" container-type="java.lang.ArrayList"
   type="inventory.aai.onap.org.v14.NetworkResource"String"/>
  </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:<xml-element name="network-resourcename">
 <xs:complexType>
   <xs:sequence>
    <xs: type="java.lang.String"/>
  <xml-element name="network-iddescription" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="provider-idtype" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="client-idrole" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="tegenerated-toposite-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element refname="tns:pnfsp-location"
     minOccurs="0" maxOccurs="1type="inventory.aai.onap.org.v14.PLocation"/>
    <xs:<xml-element refname="tns:relationship-list" 
     minOccurs="0" maxOccurs="1type="inventory.aai.onap.org.v14.RelationshipList"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:java-attributes>
</java-type>

<java-type name="SiteResources">
 <xml-root-element name="networksite-resources"/>
 <xs:complexType><java-attributes>
   <xs:sequence>
    <xs:<xml-element refname="tns:networksite-resource" container-type="java.lang.ArrayList"
     minOccurs="0" maxOccurs="unbounded"type="inventory.aai.onap.org.v14.SiteResource"/>
   </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
 /networksite-resources/networksite-resource/{networkId}
Method: PUT
Request Body:
{
    "network-id": "{networkId}",
    "provider-id": "some provider",
    "client-id": "some client",
    "te-topo-id": "some topo",
    "pnfs": {
    
Method: PUT
Request Body:
{
    "pnfid" : [
            {
           "{id}",
     "pnf-name": "some name 1"
            },
            {
                "pnf-name"description": "namesome 2description",
            }"type": "some type",
    "role": "some role",
  ]
  "generated-site-id": "some }id",
    "relationship-list": {
        "relationship" : [
            {
                "related-to": "vpnservice-bindinginstance",
                "related-link": "url of vpnservice-bindinginstance",
                "relationship-data": [
                    "relationship-key": "vpnservice-bindinginstance.vpnservice-instance-id",
                    "relationship-value": "some id"
                ]
            }
        ]
    },
    "p-location": {
        "location-name": "some name",
     ]
   "emails": "some email",
       }
 "address":   "some address",
    ]
    }
}

AAI-1353-11

"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":

termination-point

Notes:

See Figure 4 above.

Update existing class of objects.

aai_schema_v13.xsd

"p-interface"
"vpn-bindings"

add properties to existing 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="relationship-list" type="inventory.aai.onap.org.v14.RelationshipList"/> </java-attributes> </java-type>

Code Block

language	xml
title	Mockup Schema (XSDOXM)
collapse	true

<xs:element<java-type name="p-interfacePLocation">
 <xs:complexType>
   <xs:sequence>
    <xs:<xml-root-element name="networkp-ref" type="xs:string"location"/>
 <java-attributes>
   <xs:<xml-element name="transparentlocation-name" type="xs:string">
    <xs:element ref="tns:relationship-list"
     minOccurs="0" maxOccurs="1java.lang.String"/>
  <xml-element name="emails" 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
 /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": {
        "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

<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>

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="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">

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

Update existing entry points to graph for 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="extnetwork-aai-networksresources" />
    <java-attributes>
      <xml-element name="ext-aai-network"
    network-resource" container-type="java.lang.ArrayList"
   type="inventory.aai.onap.org.v14.ExtAaiNetworkNetworkResource" />
    </java-attributes>
</java-type>

<java-type name="ExtAaiNetwork">
  <xml-root-element name="ext-aai-network" />
  <java-attributes>

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:
{
    <xml-element name="aai"network-id": "{networkId}",
    "provider-id": type="java.lang.String"
  "some provider",
    required="trueclient-id": xml-key="true">"some client",
    <xml-element name="schema-version" type="java.lang.String">
    <xml-element name="esr-system-info"
"te-topo-id": "some topo",
    "pnfs": {
        type="inventory.aai.onap.org.v14.EsrSystemInfo" />"pnf" : [
    <xml-element name="logical-links"        {
      type="inventory.aai.onap.org.v14.LogicalLinks" />
          <xml-element name="vpn-bindings"
"pnf-name": "name 1"
        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="port-configs"
"pnf-name": "name 2"
           type="inventory.aai.onap.org.v14.PortConfigs" /> }
    <xml-element name="network-resources"
   ]
   type="inventory.aai.onap.org.v14.NetworkResources" /> },
    <xml-element name="site-resources"
"relationship-list": {
        type="inventory.aai.onap.org.v14.SiteResources" />
"relationship" : [
      <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"
"related-to": "vpn-binding",
            type="inventory.aai.onap.org.v14.PortResources" />
  </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="extrelated-aai-networks">
 <xs:complexType>
   <xs:sequence>link": "url of vpn-binding",
    <xs:element ref="tns:ext-aai-network"
     minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:element name="extrelationship-aai-network">
 <xs:complexType>data": [
   <xs:sequence>
    <xs:element name="aai-id" type="xs:string">
    <xs:element name="schema-version" type="xs:string">
    <xs:element ref="tns:esr-system-info"/>
 "relationship-key": "vpn-binding.vpn-id",
     <xs:element ref="tns:logical-links"/>
    <xs:element ref="tns:vpn-bindings"/>
    <xs:element ref="tns:pnfs"/>

    <xs"relationship-value":element ref="tns:connectivities"/>"some id"
    <xs:element ref="tns:port-configs"/>
    <xs:element ref="tns:network-resources"/>
    <xs:element ref="tns:site-resources"/>
  ]
      <xs:element ref="tns:sdwan-vpns"/>
    <xs:element ref="tns:devices"/>
 }
       <xs:element ref="tns:port-resources"/> ]
   </xs:sequence>
 </xs:complexType>
</xs:element> }
}

AAI-1353-13SDWAN VPN11

termination-point

Notes:

See Figure

10

4 above.

Proposal for specific new

Update existing class of

"sdwan-vpn"

objects.

aai_schema_v13.xsd

"

service

p-

instance

interface"

new element

"

sdwan

vpn-

vpn" and new element "sdwan-vpns"

bindings"

add properties to existing "p-interface" object:

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="

SdwanVpn

PInterface">
 <xml-root-element name="

sdwan

p-

vpn

interface"/>
 <java-attributes>
  <xml-element name="

id

network-ref" type="java.lang.String"/>
  <xml-element name="

name

transparent" type="java.lang.String"/>
  <xml-element name="

vxlan

relationship-

id

list" 
   type="

java.lang.String

inventory.aai.onap.org.v14.RelationshipList"/>

<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="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>

</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": {
        "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="port-configs"
      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>

AAI-1353-13

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

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="sdwan-vpn">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="id" type="xs:string" minOccurs="1">
    <xs:element name="name" type="xs:string">
    <xs:element name="vxlan-id" type="xs:string">
    <xs:element name="topology" type="xs:string">
    <xs:element name="tenant-id" type="xs:string">
    <xs:element name="vpn-id" type="xs:string">
    <xs:element ref="tns:relationship-list"
     minOccurs="0" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:element name="sdwan-vpns">
 <xs:complexType>
   <xs:sequence>
    <xs:element ref="tns:sdwan-vpn"
     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/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",
    "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

<java-type name="SdwanVpn">
 <xml-root-element name="sdwan-vpn"/>
 <java-attributes>
  <xml-element name=

"Device"

"id" type="java.lang.String"/>
  <xml

-root

-element name=

"device

"name" type="java.lang.String"/>

<java-attributes>


  <xml-element name="vxlan-id" type="java.lang.String"/>
  <xml-element name="

esn

topology" type="java.lang.String"/>
  <xml-element name="

name

tenant-id" type="java.lang.String"/>
  <xml-element name="

description

vpn-id" type="java.lang.String"/>
  <xml-element name="

vendor

relationship-list" 
   type="

java.lang.String"/>

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="

class

sdwan-vpn" container-type="java.lang.

String

ArrayList"

/>

<xml-element name="type"

 type="

java.lang.String

inventory.aai.onap.org.v14.SdwanVpn"/>
 </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",
    "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="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",
    "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":

<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="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	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="device">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="id" type="xs:string" minOccurs="1">
    <xs:element name="esn" type="xs:string">
    <xs:element name="name" type="xs:string">
    <xs:element name="description" type="xs:string">
    <xs:element name="vendor" type="xs:string">
    <xs:element name="class" type="xs:string">
    <xs:element name="type" type="xs:string">
    <xs:element name="version" type="xs:string">
    <xs:element name="system-ip" type="xs:string">
    <xs:element name="device-id" type="xs:string">
    <xs:element ref="tns:relationship-list"
     minOccurs="0" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:element name="devices">
 <xs:complexType>
   <xs:sequence>
    <xs:element ref="tns:device"
     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/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",
    "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" 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="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>

Code Block

language	xml
title	Mockup Schema (XSDOXM)
collapse	true

<xs:<java-type name="PortResource">
 <xml-root-element name="port-resource"/>
 <xs:complexType><java-attributes>
   <xs:sequence>
    <xs:<xml-element name="id" type="xs:string"id" minOccurstype="1java.lang.String"/>
    <xs:<xml-element name="name" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="device-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="vlan-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="ip-address" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="provider-ip-address" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="input-bandwidth" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="output-bandwidth" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="description" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="port-type" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="port-number" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="transport-network-name" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="device-port-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="wan-port-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element refname="tns:relationship-list" 
     minOccurs="0" maxOccurs="1type="inventory.aai.onap.org.v14.RelationshipList"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:java-attributes>
</java-type>

<java-type name="PortResources">
 <xml-root-element name="port-resources"/>
 <xs:complexType><java-attributes>
   <xs:sequence>
    <xs:<xml-element refname="tns:port-resource"device" container-type="java.lang.ArrayList"
     minOccurs="0" maxOccurs="unbounded"type="inventory.aai.onap.org.v14.PortResource"/>
   </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
 /port-resources/port-resource/{id}
Method: PUT
Request Body:
{
    "id": "{id}",
    "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",
    "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"
                ]
            }
        ]
    }
}

...

Space shortcuts

Page tree

Versions Compared

Old Version 74

New Version 75

Key