Reference Id | CCVPN Use Case Reference | AAI Schema Reference | AAI Proposed Schema |
---|
AAI-1353-1 |
| aai_schema_v13.xsd | Update existing "network" and "business" entry points to graph for new proposed elements: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="Network">
<xml-root-element name="network"/>
<java-attributes>
<xml-element name="connectivities"
type="inventory.aai.onap.org.v14.Connectivities"/>
<xml-element name="lan-port-configs"
type="inventory.aai.onap.org.v14.PortConfigsLanPortConfigs"/>
<xml-element name="network-resources"
type="inventory.aai.onap.org.v14.NetworkResources"/>
<xml-element name="site-resources"
type="inventory.aai.onap.org.v14.SiteResources"/>
<xml-element name="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="deviceswan-port-configs"
type="inventory.aai.onap.org.v14.DevicesWanPortConfigs"/>
<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-
| AAI-1353-2 | SOTN Infra Closed Loop Site Service Instance Notes: See Figure 2 above. Use existing class of objects. Closed loop scenario: - SO will create “service-instance” object in AAI
- SO will store “customer-request” string on service-instance object in AAI
- When Closed Loop call recreates the “service-instance”, it will query “service-instance” information first, to get the “customer-request”
| aai_schema_v13.xsd - "service-instance"
- "service-instances"
| add properties to existing "service-instance" object: Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="ServiceInstance">
<xml-root-element name="service-instance"/>
<java-attributes>
<xml-element name="customerinput-requestsparameters" type="java.lang.String"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | xmljs |
---|
title | Mockup Schema (XSD)API |
---|
collapse | true |
---|
| <xs:element name="service-instance">
<xs:complexType>
<xs:sequence>URL: https://<AAI host>:<AAI port>/aai/v14/business
/customers/customer/{global-customer-id}
/service-subscriptions/service-subscription/{service-type}
/service-instances/service-instance/{service-instance-id}
Method: PUT
Request Body:
{
service-instance-id: "{service-instance-id}",
<xs:elementservice-instance-name: "instance 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"
}
|
",
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"/> |
| 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="connectivitycolor-idaware" type="java.lang.String"/>
<xml-element name="bandwidthcoupling-profile-nameflag" type="java.lang.String"/>
<xml-element name="vpnetht-svc-typename" type="java.lang.String"/>
<xml-element name="CIRaccess-provider-id" type="java.lang.String"/>
<xml-element name="EIRaccess-client-id" type="java.lang.String"/>
<xml-element name="CBSaccess-topology-id" type="java.lang.String"/>
<xml-element name="EBSaccess-node-id" type="java.lang.String"/>
<xml-element name="coloraccess-ltp-awareid" type="java.lang.String"/>
<xml-element name="couplingconnectivity-flagselflink" type="java.lang.String"/>
<xml-element name="etht-svc-namecvlan" type="java.lang.String"/>
<xml-element name="accessoperational-provider-idstatus" type="java.lang.String"/>
<xml-element name="accessmodel-clientcustomization-id" type="java.lang.String"/>
<xml-element name="accessmodel-topologyversion-id" type="java.lang.String"/>
<xml-element name="accessmodel-nodeinvariant-id" type="java.lang.String"/>
<xml-element name="accessrelationship-ltp-id"list"
type="java.lang.Stringinventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="Connectivities">
<xml-root-element name="connectivity-selflink" type="java.lang.String"/>connectivities"/>
<java-attributes>
<xml-element name="cvlanconnectivity" container-type="java.lang.String"/>
<xml-element name="relationship-list" ArrayList"
type="inventory.aai.onap.org.v14.RelationshipListConnectivity"/>
</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",
"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"
] | 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" : [
{
}
]
}
}
|
|
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="relatedaccess-provider-toid": "service-instance",type="java.lang.String"/>
"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"
]
}
]
}
}
<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 | new element "sp-partner" and new element "sp-partners": | 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 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 (XSDOXM) |
---|
collapse | true |
---|
| <xs:element<java-type name="vpn-bindingSpPartner">
<xs:complexType>
<xs:sequence>
<xs:<xml-root-element name="accesssp-provider-id" type="xs:string"partner"/>
<java-attributes>
<xs:<xml-element name="accesssp-clientpartner-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="access-topology-idurl" type="xs:string"java.lang.String"/>
<xs:<xml-element name="src-access-node-idcallsource" type="xs:string"java.lang.String"/>
<xs:<xml-element name="src-access-ltp-id" type="xs:string">
<xs:element name="dst-access-node-id" type="xs:string">
<xs: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="dst-access-ltp-id"sp-partner"
type="xs:string">
</xs:sequence>
</xs:complexType>
</xs:element>
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/networkbusiness
/vpnsp-bindingspartners/vpnsp-bindingpartner/vpnIdpartnerId
Method: PUT
Request Body:
{
"vpnsp-partner-id": "vpnIdpartnerId",
"vpn-nameurl": "vpnpartner nameurl",
"access-provider-idcallsource": "providersome idsource",
"accessrelationship-client-idlist": "client id",{
"access-topology-id": "topology id",
"src-access-node-id": "src node id",
relationship" : [
"src-access-ltp-id": "src ltp id",{
"dst-access-node-id": "dst node id",
"dst-access-ltp-id": "dst ltp id"
}
|
| AAI-1353-5 | SP Partner
Notes:
See Figure 2 above.
Proposal for specific new class of "sp-partner" objects.
aai_schema_v13.xsd | new element "sp-partner" and new element "sp-partners":
"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="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 | <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 | SOTN Attachment<java-type name="AllottedResource">
<xml-root-element name="allotted-resource"/>
<java-attributes>
<xml-element name="allotted-resource-name" type="java.lang.String"/>
<xml-element name="access-provider-id" type="java.lang.String"/>
<xml-element name="access-client-id" type="java.lang.String"/>
<xml-element name="access-topology-id" type="java.lang.String"/>
<xml-element name="access-node-id" type="java.lang.String"/>
<xml-element name="access-ltp-id" type="java.lang.String"/>
<xml-element name="cvlan" type="java.lang.String"/>
<xml-element name="vpn-name" type="java.lang.String"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/business
/customers/customer/{global-customer-id}
/service-subscriptions/service-subscription/{service-type}
/service-instances/service-instance/{service-instance-id}
/allotted-resources/allotted-resource/{id}
Method: PUT
Request Body:
{
"allotted-resource-name": "some name",
"access-provider-id": "provider id",
"access-client-id": "client id",
"access-topology-id": "topology id",
"access-node-id": "node id",
"access-ltp-id": "ltp id",
"cvlan": "some tag",
"vpn-name": "some name"
}
|
| AAI-1353-7 | LAN port config Notes: See Figure 3 above. | Update existing Proposal for specific new class of "lan-port-config" objects.
| aai_schema_v13.xsd | allotted | resource | "allotted-resources"add properties to existing objectnew element "lan-port-config" and new element "lan-port-configs": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name=" |
| AllottedResourceLanPortConfig">
<xml-root-element name=" |
| allotted | resource | -attributes>
<xml-element name="name" type="java.lang.String"/>-attributes>
<xml-element name=" |
| access | providerconfig-id" type="java.lang.String"/>
<xml-element name=" |
| access | client | idname" type="java.lang.String"/>
<xml-element name=" |
| access-topology-iddescription" type="java.lang.String"/>
<xml-element name=" |
| access-nodedevice-id" type="java.lang.String"/>
<xml-element name=" |
| access-ltpport-id" type="java.lang.String"/>
<xml-element name=" |
| cvlanip-address" type="java.lang.String"/>
<xml-element name=" |
| vpn | nametag" 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: | access | provider-id | xs:string" | <xs: | access | client-id | xs:string" | <xs: | access | topology-id" | xs:string"inventory.aai.onap.org.v14.DhcpServices"/>
|
| <xs: | access | node-id" | xs:string">
<xs:element name="access-ltp-id" type="xs:string">
<xs:inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="LanPortConfigs">
<xml-root-element name=" |
| cvlan" type="xs:string"lan-port-configs"/>
<java-attributes>
|
| <xs: | vpn | name | xs:string"> | </xs:sequence>type="inventory.aai.onap.org.v14.LanPortConfigs"/>
</ |
| 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}: https://<AAI host>:<AAI port>/aai/v14/network
/lan-port-configs/lan-port-config/id
Method: PUT
Request Body:
{
" |
| name": "some name",
"access-provider | provider | access | client-id": "client id",
"access-topology-id | topology | id | access-node-id | node | id | access-ltp | ltp | id | cvlan | tag | vpn | name | 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 | 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="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> |
Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="port-config">
<xs:complexType>
<xs:sequence>
<xs:element name="port-id" type="xs:string">
<xs:element name="config-type" type="xs:string">
<xs:element ref="tns:relationship-list"
minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="port-configs">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:port-config"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/port-configs/port-config/portId
Method: PUT
Request Body:
{
"port-id": "portId",
"config-type": "lan or wan",
"relationship-list": {
"relationship" : [
{,
"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",
"relatedserver-ip-toaddress": "service-instance",some server"
}
"related-link": "url of service-instance",]
},
"relationship-list": {
"relationship-data" : [
{
"relationshiprelated-keyto": "service-instance.service-instance-id",
"relationshiprelated-valuelink": "some id"
url of service-instance",
]
}"relationship-data": [
]
}
}
|
| 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="namerelationship-key": type="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.lang.String"/>
<xml-element name="description" type="java.lang.String"/>
<xml-element name="type" type="java.lang.String"/>
<xml-element name="role" type="java.lang.String"/>
<xml-element name="generated-site-id" type="java.lang.String"/>
<xml-element name="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="SiteResourcesDhcpService">
<xml-root-element name="sitedhcp-resourcesservice"/>
<java-attributes>
<xml-element name="siteservice-resourceenable" container-type="java.lang.ArrayListString"/>
<xml-element typename="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:dhcp-service-type" type="java.lang.String"/>
<xml-element name="idlease-time" type="xs:string"java.lang.String"/>
<xs:<xml-element name="domain-name" type="xs:string"java.lang.String"/>
<xs:<xml-element name="descriptiondns" type="xs:string"java.lang.String"/>
<xs:<xml-element name="typentp-primary" type="xs:string"java.lang.String"/>
<xs:<xml-element name="rolentp-secondary" type="xs:string"java.lang.String"/>
<xs:<xml-element name="generated-site-idnbns" type="xs:string">
<xs:element ref="tns:relationship-list"java.lang.String"/>
minOccurs="0" maxOccurs="1<xml-element name="server-ip-address" type="java.lang.String"/>
<xs:<xml-element refname="tns:prelationship-locationlist"
minOccurstype="1inventory.aai.onap.org.v14.RelationshipList"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:elementjava-attributes>
</java-type>
<java-type name="site-resourcesDhcpServices">
<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 |
---|
| <xml-root-element name="dhcp-services"/>
<java-attributes>
<xml-element name="dhcp-service" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.DhcpService"/>
</java-attributes>
</java-type> |
|
AAI-1353-8 | site-resource Notes: See Figure 3 above. |
| new element "site-resource" and new element "site-resources": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="SiteResource">
<xml-root-element name="site-resource"/>
<java-attributes>
<xml-element name="site-resource-id" type="java.lang.String"/>
<xml-element name="site-resource-name" type="java.lang.String"/>
<xml-element name="description" type="java.lang.String"/>
<xml-element name="type" type="java.lang.String"/>
<xml-element name="role" type="java.lang.String"/>
<xml-element name=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",type="java.lang.String"/>
<xml-element name="selflink" "relationship-list": {type="java.lang.String"/>
<xml-element name="operational-status" type="java.lang.String"/>
<xml-element name="model-customization-id" type="java.lang.String"/>
<xml-element name="model-version-id" type="java.lang.String"/>
<xml-element name="model-invariant-id" type="java.lang.String"/>
<xml-element name="relationship-list"
type="inventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="SiteResources">
<xml-root-element name="site-resources"/>
<java-attributes>
<xml-element name="site-resource" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.SiteResource"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/site-resources/site-resource/{id}
Method: PUT
Request Body:
{
"site-resource-id": "{id}",
"site-resource-name": "some name",
"description": "some description",
"type": "some type",
"role": "some role",
"generated-site-id": "some id",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"relationship-list": {
"relationship" : [
"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"
}
}
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
},
{
"related-to": "complex",
"related-link": "url of complex",
"relationship-data": [
"relationship-key": "complex.physical-location-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-9 | physical location Notes: See Figure 3 above. | aai_schema_v13.xsd | use existing element "complex" to represent "physical location".
|
AAI-1353-10 | topo-network Notes: See Figure 4 above. Proposal for specific new class of "network-resource" objects.
| aai_schema_v13.xsd - "pnfs"
- "p-interfaces"
- "vpn-bindings"
| new element "network-resource" and new element "network-resources": | 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="location-name" type="java.lang.String"/>
<xml-element name="emails" type="java.lang.String"/>
<xml-element name="postcode" type="java.lang.String"/>
<xml-element name="address" type="java.lang.String"/>
<xml-element name="latitude" type="java.lang.String"/>
<xml-element name="longitude" type="java.lang.String"/>
</java-attributes>
</java-type>
<java-type name="PLocations">
<xml-root-element name="p-locations"/>
<java-attributes>
<xml-element name="p-location" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.PLocation"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs: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.
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="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 | xml |
---|
title | Mockup Schema (XSDOXM) |
---|
collapse | true |
---|
| <xs:<java-type name="networkResource">
<xml-root-element name="network-resource">
<xs:complexType>
<xs:sequence>
<xs:/>
<java-attributes>
<xml-element name="network-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="provider-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="client-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="te-topo-id" type="xs:string"java.lang.String"/>
<xml-element <xs:element ref="tns:pnfs"name="selflink" type="java.lang.String"/>
minOccurs<xml-element name="0pnfs"
maxOccurstype="1inventory.aai.onap.org.v14.Pnfs"/>
<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="networkResources">
<xml-root-element name="network-resources"/>
<xs:complexType><java-attributes>
<xs:sequence>
<xs:<xml-element refname="tns:network-resource"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element> container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.NetworkResource"/>
</java-attributes>
</java-type> |
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/network-resources/network-resource/{networkId}
Method: PUT
Request Body:
{
"network-id": "{networkId}",
"provider-id": "some provider",
"client-id": "some client",
"te-topo-id": "some topo",
"selflink": "some URL",
"pnfs": {
"pnf" : [
{
"pnf-name": "name 1"
},
{
"pnf-name": "name 2"
}
]
},
"relationship-list": {
"relationship" : [
{
"related-to": "vpn-binding",
"related-link": "url of vpn-binding",
"relationship-data": [
"relationship-key": "vpn-binding.vpn-id",
"relationshiprelated-valuelink": "some id"
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-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 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:<java-type name="PInterface">
<xml-root-element name="p-interface"/>
<xs:complexType><java-attributes>
<xs:sequence>
<xs:<xml-element name="network-ref" type="xs:string"java.lang.String"/>
<xs:<xml-element name="transparent" type="xs:string"java.lang.String"/>
<xml-element <xs:element ref="tns:name="operational-status" type="java.lang.String"/>
<xml-element name="relationship-list"
minOccurs="0" maxOccurs="1"type="inventory.aai.onap.org.v14.RelationshipList"/>
</xs:sequence>
</xs:complexType>
</xs:element>java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/pnfs/pnf/{pnfName}
/p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
"interface-name": "{tp-id}",
"network-ref": "some network",
"transparent": "some value",
"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 |
| 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"
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" /="java.lang.String">
<xml-element name="pnfsesr-system-info"
type="inventory.aai.onap.org.v14.PnfsEsrSystemInfo" />
<xml-element name="connectivitieslogical-links"
type="inventory.aai.onap.org.v14.ConnectivitiesLogicalLinks" />
<xml-element name="portvpn-configsbindings"
type="inventory.aai.onap.org.v14.PortConfigsVpnBindings" />
<xml-element name="network-resourcespnfs"
type="inventory.aai.onap.org.v14.NetworkResourcesPnfs" />
<xml-element name="site-resourcesconnectivities"
type="inventory.aai.onap.org.v14.SiteResourcesConnectivities" />
<xml-element name="sdwanlan-port-vpnsconfigs"
type="inventory.aai.onap.org.v14.SdwanVpnsLanPortConfigs" />
<xml-element name="devicesnetwork-resources"
type="inventory.aai.onap.org.v14.DevicesNetworkResources"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:element name="ext-aai-networks">
<xs:complexType>
<xs:sequence>
<xs:<xml-element refname="tns:ext-aai-networksite-resources"
minOccurstype="0inventory.aai.onap.org.v14.SiteResources" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs: <xml-element name="extsdwan-aai-networkvpns">
<xs:complexType>
<xs:sequence>
<xs:element nametype="aai-id" type="xs:string"inventory.aai.onap.org.v14.SdwanVpns"/>
<xs:<xml-element name="schema-versiondevices"
type="xs:string"inventory.aai.onap.org.v14.Devices"/>
<xs:<xml-element refname="tns:esrwan-systemport-infoconfigs"/>
<xs:element ref="tns:logical-links"type="inventory.aai.onap.org.v14.WanPortConfigs" />
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI <xs:element ref="tns:vpn-bindings"/>
<xs:element ref="tns:pnfs"/>
host>:<AAI port>/aai/v14/network
/ext-aai-networks/ext-aai-network/{aaiId}
/p-interfaces/p-interface/{tp-id}
Method: PUT
Request Body:
{
<xs:element ref="tns:connectivities"/>"aai-id-name": "{aaiId}",
<xs"schema-version":element ref="tns:port-configs"/>
"some version",
<xs:element ref="tns:network-resources"/>
"esr-system-info": {
<xs:element ref="tns:site-resources"/>
<xs:element ref="tns:sdwan-vpns"/>
<xs:element ref="tns:devices"/>
</xs:sequence>
</xs:complexType>
</xs:element>"esr-system-info-id": "some id",
"system-name": "some name"
}
}
|
|
AAI-1353-13 | SDWAN VPN Notes: See Figure 10 above. Proposal for specific new class of "sdwan-vpn" objects. | aai_schema_v13.xsd | new element "sdwan-vpn" and new element "sdwan-vpns": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="SdwanVpn">
<xml-root-element name="sdwan-vpn"/>
<java-attributes>
<xml-element name="id" type="java.lang.String"/>
<xml-element name="name" type="java.lang.String"/>
<xml-element name="vxlan-id" type="java.lang.String"/>
<xml<java-type name="SdwanVpn">
<xml-root-element name="topology" type="java.lang.String"sdwan-vpn"/>
<xml-element name="tenant-id" type="java.lang.String"/><java-attributes>
<xml-element name="sdwan-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.String"/>
<xml-element name="sdwan-vpns-vpn-name" type="java.lang.String"/>
<java-attributes>
<xml-element name="sdwanvxlan-vpnid" container-type="java.lang.ArrayListString"/>
<xml-element name="topology" type="inventoryjava.aai.onap.org.v14.SdwanVpnlang.String"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs:<xml-element name="sdwan-vpn"tenant-id" type="java.lang.String"/>
<xs:complexType>
<xs:sequence>
<xs: <xml-element name="vpn-id" type="xs:string" minOccurs="1"java.lang.String"/>
<xs:<xml-element name="nameselflink" type="xs:string"java.lang.String"/>
<xs:<xml-element name="vxlanoperational-idstatus" type="xs:string"java.lang.String"/>
<xs:<xml-element name="topologymodel-customization-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="tenantmodel-version-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="vpnmodel-invariant-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="SdwanVpns">
<xml-root-element name="sdwan-vpns"/>
<xs:complexType><java-attributes>
<xs:sequence>
<xs:<xml-element refname="tns:sdwan-vpn"
minOccurs="0" maxOccurs="unbounded container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.SdwanVpn"/>
</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
/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",
"relationship-listselflink": {
"some URL",
"relationship" : ["operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some {
version",
"related-to"model-invariant-id": "service-instancesome invariant",
"relatedrelationship-linklist": "url of service-instance",
{
"relationship" : [
"relationship-data": [
{
"relationshiprelated-keyto": "service-instance.service-instance-id",
"relationshiprelated-valuelink": "some id"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> |
| 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"
esn" type="inventoryjava.aai.onap.org.v14.RelationshipListlang.String"/>
</java-attributes>
</java-type>
<java-type name="Devices">
<xml-root-element name="devices"/>
<java-attributes>
<xml-element name="device" container-device-name" type="java.lang.ArrayListString"/>
<xml-element name="description" type="inventoryjava.aai.onap.org.v14.Devicelang.String"/>
</java-attributes>
</java-type>
| Code Block |
---|
language | xml |
---|
title | Mockup Schema (XSD) |
---|
collapse | true |
---|
| <xs: <xml-element name="device">
<xs:complexType>
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="1">
<xs:vendor" type="java.lang.String"/>
<xml-element name="esnclass" type="xs:string"java.lang.String"/>
<xs:<xml-element name="nametype" type="xs:string"java.lang.String"/>
<xs:<xml-element name="descriptionversion" type="xs:string"java.lang.String"/>
<xs:<xml-element name="vendorsystem-ip" type="xs:string"java.lang.String"/>
<xs:<xml-element name="classselflink" type="xs:string"java.lang.String"/>
<xs:<xml-element name="typeoperational-status" type="xs:string"java.lang.String"/>
<xs:<xml-element name="versionmodel-customization-id" type="xs:string"java.lang.String"/>
<xs:<xml-element name="systemmodel-version-ipid" type="xs:string"java.lang.String"/>
<xs:<xml-element name="devicemodel-invariant-id" type="xs:string"java.lang.String"/>
<xs:<xml-element refname="tns:relationship-list"
minOccurs="0" maxOccurs="1"type="inventory.aai.onap.org.v14.RelationshipList"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:elementjava-attributes>
</java-type>
<java-type name="devicesDevices">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:device"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element><xml-root-element name="devices"/>
<java-attributes>
<xml-element name="device" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.Device"/>
</java-attributes>
</java-type>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/devices/device/{id}
Method: PUT
Request Body:
{
"device-id": "{id}",
"esn": "an esn",
"device-name": "a name",
"description": "a description",
"vendor": "vendor value",
"class": "a class",
"type": "a type",
"version": "version value",
"system-ip-ip": "ip value",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "ipsome valueversion",
"devicemodel-invariant-id": "idsome valueinvariant",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-15 | SDWAN Port Notes: Proposal for specific new class of "wan-port-config" objects. |
| new element "wan-port-config" and new element "wan-port-configs": Code Block |
---|
language | xml |
---|
title | Mockup Schema (OXM) |
---|
collapse | true |
---|
| <java-type name="WanPortConfig">
<xml-root-element name="wan-port-config"/>
<java-attributes>
<xml-element name="wan-port-config-id" type="java.lang.String"/>
<xml-element }name="wan-port-config-name" type="java.lang.String"/>
<xml-element ]name="device-id" type="java.lang.String"/>
}
}
|
| 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<xml-element name="vlan-id" type="java.lang.String"/>
<xml-element name="ip-address" type="java.lang.String"/>
<xml-element name="port-resourceprovider-ip-address" type="java.lang.String"/>
<java-attributes> <xml-element name="input-bandwidth" type="java.lang.String"/>
<xml-element name="idoutput-bandwidth" type="java.lang.String"/>
<xml-element name="namedescription" type="java.lang.String"/>
<xml-element name="deviceport-idtype" type="java.lang.String"/>
<xml-element name="vlanport-idnumber" type="java.lang.String"/>
<xml-element name="iptransport-network-addressname" type="java.lang.String"/>
<xml-element name="providerdevice-ipport-addressid" type="java.lang.String"/>
<xml-element name="inputwan-port-bandwidthid" type="java.lang.String"/>
<xml-element name="output-bandwidthselflink" type="java.lang.String"/>
<xml-element name="descriptionoperational-status" type="java.lang.String"/>
<xml-element name="portmodel-customization-typeid" type="java.lang.String"/>
<xml-element name="portmodel-version-numberid" type="java.lang.String"/>
<xml-element name="transportmodel-networkinvariant-nameid" type="java.lang.String"/>
<xml-element name="devicerelationship-port-idlist"
type="java.lang.Stringinventory.aai.onap.org.v14.RelationshipList"/>
</java-attributes>
</java-type>
<java-type name="WanPortConfigs">
<xml-root-element name="wan-port-id" type="java.lang.Stringconfigs"/>
<xml-element name="relationship-list" <java-attributes>
<xml-element name="wan-port-config" container-type="java.lang.ArrayList"
type="inventory.aai.onap.org.v14.RelationshipListWanPortConfig"/>
</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 (XSD) |
---|
collapse | true |
---|
| <xs:element name="port-resource">
<xs:complexType>
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="1">
<xs:element name="name" type="xs:string">
<xs:element name="device-id" type="xs:string">
<xs:element name="vlan-id" type="xs:string">
<xs:element name="ip-address" type="xs:string">
<xs:element name="provider-ip-address" type="xs:string">
<xs:element name="input-bandwidth" type="xs:string">
<xs:element name="output-bandwidth" type="xs:string">
<xs:element name="description" type="xs:string">
<xs:element name="port-type" type="xs:string">
<xs:element name="port-number" type="xs:string">
<xs:element name="transport-network-name" type="xs:string">
<xs:element name="device-port-id" type="xs:string">
<xs:element name="wan-port-id" type="xs:string">
<xs:element ref="tns:relationship-list"
minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="port-resources">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:port-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
/wan-port-configs/wan-port-config/{id}
Method: PUT
Request Body:
{
"wan-port-config-id": "{id}",
"wan-port-config-name": "a name",
"device-id": "id value",
"vlan-id": "vlan value",
"ip-address": "ip value",
"provider-ip-address": "provider ip value",
"input-bandwidth": "bandwidth value",
"output-bandwidth": "bandwidth value",
"description": "a description",
"port-type": "type value",
"port-number": "number value",
"transport-network-name": "name value",
"device-port-id": "id value",
"wan-port-id": "id value",
"selflink": "some URL",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant",
"relationship-list": {
"relationship" : [
{
"related-to": "service-instance",
"related-link": "url of service-instance",
"relationship-data": [
"relationship-key": "service-instance.service-instance-id",
"relationship-value": "some id"
]
}
]
}
}
|
|
AAI-1353-16 | pnf | aai_schema_v13.xsd | 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>
|
Code Block |
---|
language | js |
---|
title | Mockup API |
---|
collapse | true |
---|
| URL: https://<AAI host>:<AAI port>/aai/v14/network
/pnfs/pnf/{pnfName}
Method: PUT
Request Body:
{
"interface-name": "{tp-id}",
"admin-status": "some admin",
"operational-status": "some status",
"model-customization-id": "some customization",
"model-version-id": "some version",
"model-invariant-id": "some invariant", | 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"
]
}
]
}
}
|
|