Page History

...

Section

Column

References

Jira
server ONAP JIRA
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key AAI-1353
CCVPN(Cross Domain and Cross Layer VPN) USE CASE
CCVPN Closed Loop
CCVPN Use Case IM Proposal （Deprecated in R4）
CCVPN Use Case Resource IM Proposal
ONAP R3 + Modeling working space

Column

Attention to

PTL AAI James Forsyth
PTL Modeling Hui Deng
Christina Monteleone Chandra Cinthala
PTL SO Seshu Kumar Mudiganti
PTL UUI Tao Shen
Sub-C Chair Architecture Chris Donley

...

add properties to existing object:

<java-type name="ServiceInstance"> <xml-root-element name="service-instance"/> <java-attributes>customerrequests</java-attributes> </java-type> <xs:service-instance"<xs:complexType> <xs:sequence> <xs:customerrequestsxs:string" xs:sequence> </xs:complexType>xs:element>service-instance-id: "{service-instance-id}serviceinstancenameinstancenameservice-typetypeservicerolerole, resource-version: "some version", model-invariant-id: "model id", model-version-id: "model version", customer-requests: "request parameters" }

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 allotted-resourceallottedresources"add properties to existing objectAllottedResourceallotted-attributes>nameaccessprovideraccess-client-idaccess-topology-id" java.lang.Stringaccessnode-idjava.lang.String <xml-element"access-ltp-id" type="java.lang.String-element name="cvlan-tag-entry" CvlanTagEntry xml Schema (XSD)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-tag-entry": { cvlantag cvlanTag" } }

LAN port config

WAN port config

Notes:

See Figure 3 above.

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

<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="service-instance" type="inventory.aai.onap.org.v14.ServiceInstance"/> </java-attributes> </java-type> <java-type name="PortConfigs"> <xml-root-element name="port-configs"/> <java-attributes> <xml-element name="port-config" container-type="java.lang.ArrayList" type="inventory.aai.onap.org.v14.PortConfigs"/> </java-attributes> </java-type>

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="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="ext-aai-networkssdwan-vpns"
   type="inventory.aai.onap.org.v14.SdwanVpns"/>
  <xml-element name="devices"
   type="inventory.aai.onap.org.v14.ExtAaiNetworksDevices"/>
  <xml-element name="sdwanwan-port-vpnsconfigs"
   type="inventory.aai.onap.org.v14.SdwanVpnsWanPortConfigs"/>
  <xml-element name="devicesext-aai-networks"
   type="inventory.aai.onap.org.v14.DevicesExtAaiNetworks"/>
 </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: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"

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="input-parameters" 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",
    input-parameters: "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="operational-status" type="java.lang.String"/>
  <xml-element name="model-customization-id" type="java.lang.String"/>
  <xml-element name="model-version-id" type="java.lang.String"/>
  <xml-element name="model-invariant-id" type="java.lang.String"/>
  <xml-element name="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </java-attributes>
</java-type>

<java-type name="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",
    "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"/>
  <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-1353-5

SP Partner

Notes:

See Figure 2 above.

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

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="sp-partner-id" type="java.lang.String"/>
  <xml-element name="url" type="java.lang.String"/>
  <xml-element name="callsource" type="java.lang.String"/>
  <xml-element name="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",
    "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"/>

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true


  <xml-element name="

access-ltp-

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

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

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

Notes:

See Figure 3 above.

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

aai_schema_v13.xsd

"service-instances"

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

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="LanPortConfig">
 <xml-root-element name="lan-port-config"/>
 <java-attributes>
  <xml-element name="lan-port-config-id" type="java.lang.String"/>
  <xml-element name="lan-port-config-name" type="java.lang.String"/>
  <xml-element name="description" type="java.lang.String"/>
  <xml-element name="device-id" type="java.lang.String"/>
  <xml-element name="port-id" type="java.lang.String"/>

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="connectivityip-idaddress" type="java.lang.String"/>
  <xml-element name="bandwidthvlan-profile-nametag" type="java.lang.String"/>
  <xml-element name="vpninput-typebandwidth" type="java.lang.String"/>
  <xml-element name="CIRoutput-bandwidth" type="java.lang.String"/>
  <xml-element name="EIR"dhcp-services" 
   type="java.lang.Stringinventory.aai.onap.org.v14.DhcpServices"/>
  <xml-element name="CBS"relationship-list" 
   type="java.lang.String"/>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="EBSlan-port-config" container-type="java.lang.StringArrayList"/>
  <xml-element name="color-aware" type="java.lang.Stringinventory.aai.onap.org.v14.LanPortConfigs"/>
  <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-tag-entry" 
   type="inventory.aai.onap.org.v14.CvlanTagEntry"/>
  <xml-element name="service-instance" 
   type="inventory.aai.onap.org.v14.ServiceInstance"/>
  <xml-element name="vpn-bindings" 
   type="inventory.aai.onap.org.v14.VpnBindings"/>
 </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 ref="tns:cvlan-tag-entry"
     minOccurs="0" maxOccurs="1"/>
    <xs:element ref="tns:service-instance"
     minOccurs="0" maxOccurs="1"/>
    <xs:element ref="tns:vpn-bindings"
     minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:element name="connectivities">
 <xs:complexType>
   <xs:sequence>
    <xs:element ref="tns:connectivity"
     minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

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-tag-entry": {
        "cvlan-tag" : "cvlanTag"
    },
    "service-instance": {
        "service-instance-id" : "instance id"
    },
    "vpn-bindings": {
        "vpn-binding" : [
            {
                "vpn-id": "vpn id 1"
            },
            {
                "vpn-id": "vpn id 2"
            }
        ]
    }
}

AAI-1353-4

</java-attributes>
</java-type>

Code Block

language	js
title	Mockup API
collapse	true

URL: https://<AAI host>:<AAI port>/aai/v14/network
 /lan-port-configs/lan-port-config/id
Method: PUT
Request Body:
{
    "lan-port-config-id": "id",
    "lan-port-config-name": "some name",
    "description": "some description",
    "device-id": "some device",
    "port-id": "some port",
    "ip-address": "some address",
    "vlan-tag": "some tag",
    "input-bandwidth": "some input",
    "output-bandwidth": "some output",
    "dhcp-services": {
        "dhcp-service": [
            {
                "service-enable": "some enable",
                "dhcp-service-type": "some service",
                "lease-time": "some time",
                "domain-name": "some domain",
                "dns": "some dns",
                "ntp-primary": "some ntp",
                "ntp-secondary": "some secondary",
                "nbns": "some nbns",
                "server-ip-address": "some server"
            }
        ]
    },
    "relationship-list": {
        "relationship" : [
            {
                "related-to": "service-instance",
                "related-link": "url of service-instance",
                "relationship-data": [
                    "relationship-key": "service-instance.service-instance-id",
                    "relationship-value": "some id"
                ]
            }
        ]
    }
}

AAI-1353-7b

dhcp-service

new element "dhcp-service" and new element "dhcp-services", as sub-component of "lan-port-config":

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="DhcpService">
 <xml-root-element name="dhcp-service"/>
 <java-attributes>
  <xml-element name="service-enable" type="java.lang.String"/>
  <xml-element name="dhcp-service-type" type="java.lang.String"/>
  <xml-element name="lease-time" type="java.lang.String"/>
  <xml-element name="domain-name" type="java.lang.String"/>
  <xml-element name="dns" type="java.lang.String"/>
  <xml-element name="ntp-primary" type="java.lang.String"/>
  <xml-element name="ntp-secondary" type="java.lang.String"/>
  <xml-element name="nbns" type="java.lang.String"/>
  <xml-element name="server-ip-address" type="java.lang.String"/>
  <xml-element name="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </java-attributes>
</java-type>

<java-type name="DhcpServices">
 <xml-root-element name="dhcp-services"/>
 <java-attributes>
  <xml-element name="dhcp-service" container-type="java.lang.ArrayList"
   type="inventory.aai.onap.org.v14.DhcpService"/>
 </java-attributes>
</java-type>

AAI-1353-8

site-resource

Notes:

See Figure 3 above.

new element "site-resource" and new element "site-resources"

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="VpnBindingSiteResource">
 <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="site-resource"/>
 <java-attributes>
  <xml-element name="accesssite-topologyresource-id" type="java.lang.String"/>
  <xml-element name="accesssite-noderesource-idname" type="java.lang.String"/>
  <xml-element name="access-ltp-iddescription" type="java.lang.String"/>
  <xml-element name="src-access-node-idtype" type="java.lang.String"/>
  <xml-element name="src-access-ltp-idrole" type="java.lang.String"/>
  <xml-element name="dstgenerated-accesssite-node-id" type="java.lang.String"/>
  <xml-element name="dst-access-ltp-idselflink" type="java.lang.String"/>
 </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element name="vpn-binding">
 <xs:complexType>
   <xs:sequence>
    <xs:
  <xml-element name="accessoperational-provider-idstatus" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="accessmodel-clientcustomization-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="accessmodel-topologyversion-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="srcmodel-access-nodeinvariant-id" type="xs:string">
    <xs:element name="src-access-ltp-id" type="xs:string">
    <xs:java.lang.String"/>
  <xml-element name="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </java-attributes>
</java-type>

<java-type name="SiteResources">
 <xml-root-element name="dst-access-node-id" type="xs:string"site-resources"/>
 <java-attributes>
   <xs:<xml-element name="dst-access-ltp-idsite-resource" container-type="xs:string">java.lang.ArrayList"
   </xs:sequence>type="inventory.aai.onap.org.v14.SiteResource"/>
 </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
 /vpnsite-bindingsresources/vpnsite-bindingresource/vpnId{id}
Method: PUT
Request Body:
{
    "vpnsite-resource-id": "vpnId{id}",
    "vpnsite-resource-name": "vpnsome name",
    "access-providerdescription": "some description",
    "type": "some type",
    "role": "some role",
    "generated-site-id": "providersome id",
    "access-client-idselflink": "clientsome idURL",
    "accessoperational-topology-idstatus": "topologysome idstatus",
    "srcmodel-accesscustomization-node-id": "srcsome node idcustomization",
    "srcmodel-access-ltpversion-id": "src ltp"some idversion",
    "dstmodel-access-nodeinvariant-id": "dstsome node idinvariant",
    "dst-access-ltp-idrelationship-list": "dst ltp id"
}

AAI-1353-5

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

"complex"

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"

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="service-instance" 
   type="inventory.aai.onap.org.v14.ServiceInstance"/>
 </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 ref="tns:service-instance"
     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",
    "service-instance": {
        "service-instance-id" : "instance id"
    }
}

AAI-1353-6

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

<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 ref="tns:cvlan-tag-entry"
     minOccurs="0" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

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

Code Block

language	js
title	Mockup API
collapse	true

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:

AAI-1353-7

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

Code Block

language	xml
title	Mockup Schema (XSDOXM)
collapse	true

<xs:element name="port-config">
 <xs:complexType>
   <xs:sequence>
    <xs:element<java-type name="port-id" type="xs:string">
    <xs:"PInterface">
 <xml-root-element name="p-interface"/>
 <java-attributes>
  <xml-element name="confignetwork-typeref" type="xs:string"java.lang.String"/>
    <xs:<xml-element refname="tns:service-instancetransparent"
     minOccurstype="0" maxOccurs="1"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="unbounded"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>operational-status" type="java.lang.String"/>
  <xml-element name="relationship-list" 
   type="inventory.aai.onap.org.v14.RelationshipList"/>
 </java-attributes>
</java-type>

Code Block

language	js
title	Mockup API
collapse	true

URL: https://<AAI host>:<AAI port>/aai/v14/network
 /port-configs/port-config/portId
Method: PUT
Request Body:
{
    "port-id": "portId",
    "config-type": "lan or wan",pnfs/pnf/{pnfName}
 /p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
    "serviceinterface-instancename": "{tp-id}",
        "servicenetwork-instance-idref" : "instancesome idnetwork",
    }
}

AAI-1353-8

site-resource

Notes:

See Figure 3 above.

new element "site-resource" and new element "site-resources":

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="SiteResource">
 <xml-root-element name="site-resource"/>
 <java-attributes>
  <xml-element name="id" type="java.lang.String"/>
  <xml-element name="name" type="java.lang.String"/>
  <xml-element name="description" type="java.lang.String"/>
  <xml-element name="type" type="java.lang.String"/>
  <xml-element name="role" type="java.lang.String"/>
  <xml-element name="p-location"
   type="inventory.aai.onap.org.v14.PLocation"/>
 </java-attributes>
</java-type>

<java-type name="SiteResources">
 <xml-root-element name="site-resources"/>
 <java-attributes>
  <xml-element name="site-resource" container-type="java.lang.ArrayList"
   type="inventory.aai.onap.org.v14.SiteResource"/>
 </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (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 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",
    "p-location": {
        "emails": "some email",
        "address": "some address",
        "postcode": "some postcode",
        "latitude": "some latitude",
        "longitude": "some longitude"
    }
}

"transparent": "some value",
    "operational-status": "some oper",
    "speed-value": "eth bandwidth",
    "relationship-list": {
        "relationship" : [
            {
                "related-to": "vpn-binding",
                "related-link": "url of vpn-binding",
                "relationship-data": [
                    "relationship-key": "vpn-binding.vpn-id",
                    "relationship-value": "some id"
                ]
            }
        ]
    }
}

AAI-1353-12

cross-domain link

Notes:

See Figures 5, 6, 7, 8 and 9 above.

Record information in AAI that crosses between ONAP Domain 1 and ONAP Domain 2

new proposed elements "external-aai-list" and "external-aai":

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="ExtAaiNetworks">
  <xml-root-element name="ext-aai-networks" />
    <java-attributes>
      <xml-element name="ext-aai-network"
       type="inventory.aai.onap.org.v14.ExtAaiNetwork" />
    </java-attributes>
</java-type>

<java-type name="ExtAaiNetwork">
  <xml-root-element name="ext-aai-network" />
  <java-attributes>
    <xml-element name="aai-id" type="java.lang.String"
      required="true" xml-key="true">
    <xml-element name="schema-version" type="java.lang.String">
    <xml-element name="esr-system-info"
      type="inventory.aai.onap.org.v14.EsrSystemInfo" />
    <xml-element name="logical-links"
      type="inventory.aai.onap.org.v14.LogicalLinks" />
    <xml-element name="vpn-bindings"
      type="inventory.aai.onap.org.v14.VpnBindings" />
    <xml-element name="pnfs"
      type="inventory.aai.onap.org.v14.Pnfs" />

AAI-1353-9

p-location

Notes:

See Figure 3 above.

new element "p-location" and new element "p-locations", as sub-component of "site-resource":

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="PLocation">
 <xml-root-element name="p-location"/>
 <java-attributes>
  <xml-element name="emailsconnectivities"
      type="java.lang.String"inventory.aai.onap.org.v14.Connectivities" />
    <xml-element name="postcode" lan-port-configs"
      type="java.lang.String"inventory.aai.onap.org.v14.LanPortConfigs" />
    <xml-element name="address"network-resources"
      type="java.lang.String""inventory.aai.onap.org.v14.NetworkResources" />
    <xml-element name="latitude"site-resources"
      type="java.lang.String"inventory.aai.onap.org.v14.SiteResources" />
    <xml-element name="longitudesdwan-vpns"
     type="java.lang.Stringinventory.aai.onap.org.v14.SdwanVpns"/>
 </java-attributes>
</java-type>

<java-type   <xml-element name="PLocationsdevices">
 <xml-root-element name="p-locations     type="inventory.aai.onap.org.v14.Devices"/>
 <java-attributes>
   <xml-element name="p-location" container-type="java.lang.ArrayList"
 name="wan-port-configs"
      type="inventory.aai.onap.org.v14.PLocationWanPortConfigs" />
  </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="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

 https://<AAI host>:<AAI port>/aai/v14/network
 /ext-aai-networks/ext-aai-network/{aaiId}
 /p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
    "aai-id-name": "{aaiId}",
    "schema-version": "some version",
    "esr-system-info": {
        "esr-system-info-id": "some id",
        "system-name": "some name"
    }
}

AAI-1353-13

SDWAN VPN

Notes:

See Figure 10

topo-network

Notes:

See Figure 4

above.

Proposal for specific new class of "

network

sdwan-

resource

vpn" objects.

aai_schema_v13.xsd

"

pnfs"

"p-interfaces"

"vpn-bindings

service-instance"

new element "

network

sdwan-

resource

vpn" and new element "

network

sdwan-

resources

vpns":

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

<java-type name="SdwanVpn">

name="networkResource"> <xml-root

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

"network-resource

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

<java-attributes>


  <xml-element name="

network

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

provider

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

client-id

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

te

operational-

topo-id

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

pnfs

model-customization-id"

type="

inventory

java.

aai.onap.org.v14.Pnfs

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

vpn

model-version-

bindings

id"

 type="

inventory

java.

aai.onap.org.v14.VpnBindings

lang.String"/>

</java-attributes> </java-type> <java-type

 <xml-element name="

networkResources"> <xml-root-element name="network-resources"/> <java-attributes>

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

network

relationship-

resource

list"

container-type="java.lang.ArrayList"


   type="inventory.aai.onap.org.v14.

NetworkResource

RelationshipList"/>
 </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:element



<java-type name="

network-resource

SdwanVpns">

<xs:complexType> <xs:sequence> <xs:

<xml-root-element name="

network

sdwan-

id" type="xs:string"

vpns"/>

<xs:element name="provider-id" type="xs:string">

<java-attributes>

<xs:

<xml-element name="

client

sdwan-

id

vpn" container-type="

xs:string"> <xs:element name="te-topo-id" type="xs:string"> <xs:element ref="tns:pnfs" minOccurs="1" maxOccurs="unbounded"/> <xs:element ref="tns:vpn-bindings" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="network-resources"> <xs:complexType> <xs:sequence> <xs:element ref="tns:network-resource" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element>

java.lang.ArrayList"
   type="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:
{
    "sdwan-vpn-id": "{id}",
    "sdwan-vpn-name": "a name",
    "vxlan-id": "an id",
    "topology": "topology value",
    "tenant-id": "tenant value",
    "vpn-id": "vpn value",
    "selflink": "some URL",
    "operational-status": "some status

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

model-customization-id": "some

provider

customization",
    "

client

model-version-id": "some

client

version",
    "

te

model-

topo

invariant-id": "some

topo

invariant",
    "

pnfs

relationship-list": {
        "

pnf

relationship" : [
            {
                "

pnf-name

related-to": "service-instance",
                "related-link": "

name 1"

url of service-instance",
                "relationship-data": [

},

     "relationship-key": "service-instance.service-instance-id",

{

pnf

relationship-

name

value": "

name

some

2

id"

}

},

"vpn-bindings":

{

"vpn-binding" : [

}
        ]

{ "vpn-id": "vpn id 1" }, { "vpn-id": "vpn id 2" } ] } } AAI-1353-11

termination-point

Notes:

See Figure 4 above.

Update existing class of objects.

}
}

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="device-id" type="java.lang.String"/>
  <xml-element name="esn" type="java.lang.String"/>
  <xml-element name="device-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="selflink" type="java.lang.String"/>

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="networkoperational-refstatus" type="java.lang.String"/>
  <xml-element name="transparentmodel-customization-id" type="java.lang.String"/>
  <xml-element name="vpnmodel-version-bindingsid"
   type="inventoryjava.aai.onap.org.v14.VpnBindingslang.String"/>
  </java-attributes>
</java-type>

Code Block

language	xml
title	Mockup Schema (XSD)
collapse	true

<xs:<xml-element name="p-interface">
 <xs:complexType>
   <xs:sequence>
    <xs:element name="network-refmodel-invariant-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="transparentrelationship-list" 
   type="xs:string">
    <xs:element ref="tns:vpn-bindings"
     minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>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
 /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",
    "vpn-bindings": {
        "vpn-binding" : [
            {
                "vpndevices/device/{id}
Method: PUT
Request Body:
{
    "device-id": "vpn {id 1}",
    "esn":        }"an esn",
    "device-name":        {
        "a name",
        "vpn-id"description": "vpna id 2description",
    "vendor": "vendor value",
    "class":   }"a class",
    "type":    ]"a type",
    }
}

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

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="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""version": "version value",
    "system-ip": "ip value",
    "selflink": "some URL",
    "operational-status": "some status",
    "model-customization-id": "some customization",
    "model-version-id": "some version",
    "model-invariant-id": "some invariant",
    "relationship-list": {
      required=  "truerelationship" xml-key="true">
 : [
          <xml-element name="schema-version" type="java.lang.String"> {
    <xml-element name="esr-system-info-list"
      type="inventory.aai.onap.org.v14.EsrSystemInfoList" />
    <xml-element name="logical-links"
"related-to": "service-instance",
           type="inventory.aai.onap.org.v14.LogicalLinks" />
    <xml-element name="vpn-bindings""related-link": "url of service-instance",
      type="inventory.aai.onap.org.v14.VpnBindings" />
    <xml-element name="pnfs"
      type="inventory.aai.onap.org.v14.Pnfs" />

"relationship-data": [
        <xml-element name="connectivities"
      type="inventory.aai.onap.org.v14.Connectivities" />
    <xml-element name="port-configs""relationship-key": "service-instance.service-instance-id",
      type="inventory.aai.onap.org.v14.PortConfigs" />
             <xml-element name="networkrelationship-resourcesvalue"
: "some id"
    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"/>
  </java-attributes>
</java-type>

}
}

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 (XSDOXM)
collapse	true

<xs:<java-type name="WanPortConfig">
 <xml-root-element name="extwan-aaiport-networksconfig"/>
 <xs:complexType><java-attributes>
   <xs:sequence>
    <xs:<xml-element refname="tns:ext-aai-network"wan-port-config-id" type="java.lang.String"/>
     minOccurs="0" maxOccurs="unbounded<xml-element name="wan-port-config-name" type="java.lang.String"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

<xs:<xml-element name="ext-aai-network"device-id" type="java.lang.String"/>
 <xs:complexType>
   <xs:sequence>
    <xs: <xml-element name="aaivlan-id" type="xs:string"java.lang.String"/>
    <xs:<xml-element name="schemaip-versionaddress" type="xs:string"java.lang.String"/>
    <xs:<xml-element refname="tns:esr-system-info-listprovider-ip-address" type="java.lang.String"/>
    <xs:<xml-element refname="tns:logical-linksinput-bandwidth" type="java.lang.String"/>
    <xs:<xml-element refname="tns:vpn-bindingsoutput-bandwidth" type="java.lang.String"/>
    <xs:<xml-element refname="tns:pnfs"/>


    <xs:element ref="tns:connectivitiesdescription" type="java.lang.String"/>
    <xs:<xml-element refname="tns:port-configstype"/>
    <xs:element ref="tns:network-resources type="java.lang.String"/>
    <xs:<xml-element refname="tns:site-resourcesport-number" type="java.lang.String"/>
    <xs:<xml-element refname="tns:sdwan-vpns"/>
    <xs:element ref="tns:devicestransport-network-name" type="java.lang.String"/>
   </xs:sequence>
 </xs:complexType>
</xs:element>

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 (OXM)
collapse	true

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

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

id

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

name

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

vxlan

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

topology

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

service

relationship-

instance

list" 
   type="inventory.aai.onap.org.v14.

ServiceInstance

RelationshipList"/>
 </java-attributes>
</java-type>

<java-type name="

SdwanVpns

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

sdwan

wan-port-

vpns

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

sdwan

wan-port-

vpn

config" container-type="java.lang.ArrayList"
   type="inventory.aai.onap.org.v14.

SdwanVpn

WanPortConfig"/>
 </java-attributes>
</java-type>

Code Block

language

xml

js
title	Mockup

Schema (XSD)

API
collapse	true

<xs

URL:

element name="sdwan-vpn"> <xs:complexType> <xs:sequence>

 https://<AAI host>:<AAI port>/aai/v14/network
 /wan-port-configs/wan-port-config/{id}
Method: PUT
Request Body:
{

<xs:element name="id" type="xs:string" minOccurs="1">

"wan-port-config-id": "{id}",
    "wan-port-config-name": "a name",

<xs

"device-id":

element

name=

name"

id

type="xs:string">

value",

<xs:element name="vxlan

"vlan-id":

type="xs:string">

"vlan value",

<xs

"ip-address":

element

name=

topology"

ip

type="xs:string">

value",

<xs:element ref="tns:service-instance"

"provider-ip-address": "provider ip value",

minOccurs="0" maxOccurs="1"/>

"input-bandwidth": "bandwidth value",

</xs:sequence> </xs:complexType> </xs:element> <xs:element name="sdwan-vpns"> <xs:complexType> <xs:sequence>

 "output-bandwidth": "bandwidth value",
    "description": "a description",

<xs

"port-type":

element

ref="tns:sdwan-vpn"

"type value",

minOccurs="0" maxOccurs="unbounded"/>

"port-number": "number value",

</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: {

 "transport-network-name": "name value",
    "device-port-id": "id value",
    "wan-port-id": "id value",
    "selflink": "some URL",
    "

id

operational-status": "

{id}

some status",
    "

name

model-customization-id": "

a

some

name

customization",
    "

vxlan

model-version-id": "

an

some

id

version",
    "

topology

model-invariant-id": "

topology

some

value

invariant",
    "

service

relationship-

instance

list": {
        "

service-instance-id

relationship" :

"instance id"

[
            {
                "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-16pnf

aai_schema_v13.xsd

"pnf"

add properties to existing "pnf" object:

Code Block

language	xml
title	Mockup Schema (OXM)
collapse	true

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

} } 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"/>
 </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: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
 /devicespnfs/devicepnf/{idpnfName}
Method: PUT
Request Body:
{
    "idinterface-name": "{tp-id}",
    "esnadmin-status": "ansome esnadmin",
    "nameoperational-status": "asome namestatus",
    "descriptionmodel-customization-id": "asome descriptioncustomization",
    "vendormodel-version-id": "vendor value",
    "class": "a class",
    "type": "a type",
    "version": "version value"some version",
    "systemmodel-invariant-ipid": "ipsome valueinvariant",
}

Space shortcuts

Page tree

Versions Compared

Old Version 68

New Version Current

Key

References

Attention to