From 95c5189f3b8aa708feaaa78999342220321fad00 Mon Sep 17 00:00:00 2001 From: "Kajur, Harish (vk250x)" Date: Thu, 8 Mar 2018 09:40:03 -0500 Subject: Add the generated yaml and html files Issue-ID: AAI-838 Change-Id: Iad3d92964dc333b3a2f0200b6491c7577493be87 Signed-off-by: Kajur, Harish (vk250x) --- .../aai_swagger_html/aai_swagger_v12.html | 44 +- .../aai_swagger_html/aai_swagger_v13.html | 190005 ++++++++++++++++++ .../aai_swagger_yaml/aai_swagger_v12.yaml | 51 +- .../aai_swagger_yaml/aai_swagger_v13.yaml | 68602 +++++++ 4 files changed, 258694 insertions(+), 8 deletions(-) create mode 100644 aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html create mode 100644 aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml (limited to 'aai-schema') diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html index d16b210a..d039441c 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html @@ -168505,7 +168505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname

+

cloud-region designates an installation of a cloud cluster or region or instantiation.

  • TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
  • @@ -168643,6 +168643,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ cloud-extra-info: + string + + +
+
+

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

+
+ +
+
+
+ cloud-epa-caps: + string + + +
+
+

MultiVIM will discover and expose EPA capabilities.

+
+ +
+
resource-version: string @@ -169265,7 +169289,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Generic configuration object.

+

Port Mirror Configuration.

  • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
  • @@ -169378,6 +169402,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen string +

Orchestration status of the configuration.

@@ -169390,6 +169415,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen string +

Indicator for whether the resource is considered operational.

@@ -169402,6 +169428,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen string +

URL to endpoint where AAI can get more details from SDN-GC.

@@ -169414,6 +169441,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen string +

id of the configuration used to customize the resource

@@ -180929,6 +180957,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ mac-addresss: + string + + +
+
+

MAC Address of the p-interface.

+
+ +
+
resource-version: string diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html new file mode 100644 index 00000000..a9d1c9fb --- /dev/null +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html @@ -0,0 +1,190005 @@ + + + + + + + Active and Available Inventory REST API. + + +
+

Active and Available Inventory REST API.

+

Version: v12

+


+[Differences versus the previous schema version](apidocs/aai_swagger_v13.diff)
+
+Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
+
+You may obtain a copy of the License at
+
+(https://creativecommons.org/licenses/by/4.0/)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
+
+This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.

+

+ +
+ Schemes: + https +
+ + +

Summary

+ +

Tag: CloudInfrastructure

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /cloud-infrastructure/cloud-regions

returns cloud-regions

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

returns cloud-region

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

create or update an existing cloud-region

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

update an existing cloud-region

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

delete an existing cloud-region

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones

returns availability-zones

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

returns availability-zone

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

create or update an existing availability-zone

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

update an existing availability-zone

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

delete an existing availability-zone

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches

returns dvs-switches

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

returns dvs-switch

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

create or update an existing dvs-switch

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

update an existing dvs-switch

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

delete an existing dvs-switch

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors

returns flavors

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

returns flavor

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

create or update an existing flavor

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

update an existing flavor

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

delete an existing flavor

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

returns group-assignments

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

returns group-assignment

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

create or update an existing group-assignment

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

update an existing group-assignment

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

delete an existing group-assignment

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images

returns images

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

returns image

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

create or update an existing image

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

update an existing image

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

delete an existing image

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata

returns metadata

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks

returns oam-networks

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

returns oam-network

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

create or update an existing oam-network

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

update an existing oam-network

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

delete an existing oam-network

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots

returns snapshots

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

returns snapshot

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

create or update an existing snapshot

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

update an existing snapshot

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

delete an existing snapshot

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

returns tenants

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

returns tenant

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

create or update an existing tenant

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

update an existing tenant

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

delete an existing tenant

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

returns vservers

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

returns vserver

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

create or update an existing vserver

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

update an existing vserver

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

delete an existing vserver

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

returns l-interfaces

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

returns volumes

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

returns volume

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

create or update an existing volume

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

update an existing volume

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

delete an existing volume

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

returns vip-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

create or update an existing vip-ipv4-address-list

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

update an existing vip-ipv4-address-list

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

delete an existing vip-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

returns vip-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

create or update an existing vip-ipv6-address-list

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

update an existing vip-ipv6-address-list

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

delete an existing vip-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

returns volume-groups

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

returns volume-group

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

create or update an existing volume-group

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

update an existing volume-group

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

delete an existing volume-group

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/complexes

returns complexes

+
GET /cloud-infrastructure/complexes/complex/{physical-location-id}

returns complex

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

create or update an existing complex

+
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

update an existing complex

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

delete an existing complex

+
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

returns ctag-pools

+
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

returns ctag-pool

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

create or update an existing ctag-pool

+
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

update an existing ctag-pool

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

delete an existing ctag-pool

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/network-profiles

returns network-profiles

+
GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

returns network-profile

+
PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

create or update an existing network-profile

+
PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

update an existing network-profile

+
DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

delete an existing network-profile

+
PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/operational-environments

returns operational-environments

+
GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

returns operational-environment

+
PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

create or update an existing operational-environment

+
PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

update an existing operational-environment

+
DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

delete an existing operational-environment

+
PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers

returns pservers

+
GET /cloud-infrastructure/pservers/pserver/{hostname}

returns pserver

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}

create or update an existing pserver

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}

update an existing pserver

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}

delete an existing pserver

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

returns lag-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

returns p-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

returns p-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/virtual-data-centers

returns virtual-data-centers

+
GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

returns virtual-data-center

+
PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

create or update an existing virtual-data-center

+
PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

update an existing virtual-data-center

+
DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

delete an existing virtual-data-center

+
PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

delete an existing relationship

+
+ + +

Tag: Business

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /business/connectors

returns connectors

+
GET /business/connectors/connector/{resource-instance-id}

returns connector

+
PUT /business/connectors/connector/{resource-instance-id}

create or update an existing connector

+
PATCH /business/connectors/connector/{resource-instance-id}

update an existing connector

+
DELETE /business/connectors/connector/{resource-instance-id}

delete an existing connector

+
GET /business/connectors/connector/{resource-instance-id}/metadata

returns metadata

+
GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
PUT /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers

returns customers

+
GET /business/customers/customer/{global-customer-id}

returns customer

+
PUT /business/customers/customer/{global-customer-id}

create or update an existing customer

+
PATCH /business/customers/customer/{global-customer-id}

update an existing customer

+
DELETE /business/customers/customer/{global-customer-id}

delete an existing customer

+
PUT /business/customers/customer/{global-customer-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions

returns service-subscriptions

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

returns service-subscription

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

create or update an existing service-subscription

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

update an existing service-subscription

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

delete an existing service-subscription

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances

returns service-instances

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

returns service-instance

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

create or update an existing service-instance

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

update an existing service-instance

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

delete an existing service-instance

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources

returns allotted-resources

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

returns allotted-resource

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

create or update an existing allotted-resource

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

update an existing allotted-resource

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

delete an existing allotted-resource

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects

returns tunnel-xconnects

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

returns tunnel-xconnect

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

create or update an existing tunnel-xconnect

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

update an existing tunnel-xconnect

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

delete an existing tunnel-xconnect

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata

returns metadata

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/lines-of-business

returns lines-of-business

+
GET /business/lines-of-business/line-of-business/{line-of-business-name}

returns line-of-business

+
PUT /business/lines-of-business/line-of-business/{line-of-business-name}

create or update an existing line-of-business

+
PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

update an existing line-of-business

+
DELETE /business/lines-of-business/line-of-business/{line-of-business-name}

delete an existing line-of-business

+
PUT /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

delete an existing relationship

+
GET /business/owning-entities

returns owning-entities

+
GET /business/owning-entities/owning-entity/{owning-entity-id}

returns owning-entity

+
PUT /business/owning-entities/owning-entity/{owning-entity-id}

create or update an existing owning-entity

+
PATCH /business/owning-entities/owning-entity/{owning-entity-id}

update an existing owning-entity

+
DELETE /business/owning-entities/owning-entity/{owning-entity-id}

delete an existing owning-entity

+
PUT /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/platforms

returns platforms

+
GET /business/platforms/platform/{platform-name}

returns platform

+
PUT /business/platforms/platform/{platform-name}

create or update an existing platform

+
PATCH /business/platforms/platform/{platform-name}

update an existing platform

+
DELETE /business/platforms/platform/{platform-name}

delete an existing platform

+
PUT /business/platforms/platform/{platform-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

delete an existing relationship

+
GET /business/projects

returns projects

+
GET /business/projects/project/{project-name}

returns project

+
PUT /business/projects/project/{project-name}

create or update an existing project

+
PATCH /business/projects/project/{project-name}

update an existing project

+
DELETE /business/projects/project/{project-name}

delete an existing project

+
PUT /business/projects/project/{project-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/projects/project/{project-name}/relationship-list/relationship

delete an existing relationship

+
+ + +

Tag: ServiceDesignAndCreation

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /service-design-and-creation/models

returns models

+
GET /service-design-and-creation/models/model/{model-invariant-id}

returns model

+
PUT /service-design-and-creation/models/model/{model-invariant-id}

create or update an existing model

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}

update an existing model

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}

delete an existing model

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

returns model-vers

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

returns model-ver

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

create or update an existing model-ver

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

update an existing model-ver

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

delete an existing model-ver

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

returns metadata

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

returns model-elements

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

returns model-element

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

create or update an existing model-element

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

update an existing model-element

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

delete an existing model-element

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

returns model-constraints

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

returns model-constraint

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

create or update an existing model-constraint

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

update an existing model-constraint

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

delete an existing model-constraint

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

returns constrained-element-sets

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

returns constrained-element-set

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

create or update an existing constrained-element-set

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

update an existing constrained-element-set

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

delete an existing constrained-element-set

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

returns element-choice-sets

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

returns element-choice-set

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

create or update an existing element-choice-set

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

update an existing element-choice-set

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

delete an existing element-choice-set

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/named-queries

returns named-queries

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

returns named-query

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

create or update an existing named-query

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

update an existing named-query

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

delete an existing named-query

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

returns named-query-elements

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

returns named-query-element

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

create or update an existing named-query-element

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

update an existing named-query-element

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

delete an existing named-query-element

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

returns property-constraints

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

returns property-constraint

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

create or update an existing property-constraint

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

update an existing property-constraint

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

delete an existing property-constraint

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups

returns related-lookups

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

returns related-lookup

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

create or update an existing related-lookup

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

update an existing related-lookup

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

delete an existing related-lookup

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/service-capabilities

returns service-capabilities

+
GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

returns service-capability

+
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

create or update an existing service-capability

+
PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

update an existing service-capability

+
DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

delete an existing service-capability

+
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/services

returns services

+
GET /service-design-and-creation/services/service/{service-id}

returns service

+
PUT /service-design-and-creation/services/service/{service-id}

create or update an existing service

+
PATCH /service-design-and-creation/services/service/{service-id}

update an existing service

+
DELETE /service-design-and-creation/services/service/{service-id}

delete an existing service

+
PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/vnf-images

returns vnf-images

+
GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

returns vnf-image

+
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

create or update an existing vnf-image

+
PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

update an existing vnf-image

+
DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

delete an existing vnf-image

+
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

delete an existing relationship

+
+ + +

Tag: Network

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /network/configurations

returns configurations

+
GET /network/configurations/configuration/{configuration-id}

returns configuration

+
PUT /network/configurations/configuration/{configuration-id}

create or update an existing configuration

+
PATCH /network/configurations/configuration/{configuration-id}

update an existing configuration

+
DELETE /network/configurations/configuration/{configuration-id}

delete an existing configuration

+
GET /network/configurations/configuration/{configuration-id}/evcs

returns evcs

+
GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

returns evc

+
PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

create or update an existing evc

+
PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

update an existing evc

+
DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

delete an existing evc

+
PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

returns forwarder-evcs

+
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

returns forwarder-evc

+
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

create or update an existing forwarder-evc

+
PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

update an existing forwarder-evc

+
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

delete an existing forwarder-evc

+
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/configurations/configuration/{configuration-id}/metadata

returns metadata

+
GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/forwarding-paths

returns forwarding-paths

+
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

returns forwarding-path

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

create or update an existing forwarding-path

+
PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

update an existing forwarding-path

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

delete an existing forwarding-path

+
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

returns forwarders

+
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

returns forwarder

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

create or update an existing forwarder

+
PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

update an existing forwarder

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

delete an existing forwarder

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

delete an existing relationship

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs

returns generic-vnfs

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}

returns generic-vnf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}

create or update an existing generic-vnf

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

update an existing generic-vnf

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

delete an existing generic-vnf

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

returns entitlements

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

returns l-interfaces

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

returns lag-interfaces

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

returns licenses

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

returns license

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

returns vf-modules

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

returns vf-module

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

create or update an existing vf-module

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

update an existing vf-module

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

delete an existing vf-module

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/instance-groups

returns instance-groups

+
GET /network/instance-groups/instance-group/{id}

returns instance-group

+
PUT /network/instance-groups/instance-group/{id}

create or update an existing instance-group

+
PATCH /network/instance-groups/instance-group/{id}

update an existing instance-group

+
DELETE /network/instance-groups/instance-group/{id}

delete an existing instance-group

+
PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

delete an existing relationship

+
GET /network/ipsec-configurations

returns ipsec-configurations

+
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

returns ipsec-configuration

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

create or update an existing ipsec-configuration

+
PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

update an existing ipsec-configuration

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

delete an existing ipsec-configuration

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

returns vig-servers

+
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

returns vig-server

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

create or update an existing vig-server

+
PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

update an existing vig-server

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

delete an existing vig-server

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

delete an existing relationship

+
GET /network/l3-networks

returns l3-networks

+
GET /network/l3-networks/l3-network/{network-id}

returns l3-network

+
PUT /network/l3-networks/l3-network/{network-id}

create or update an existing l3-network

+
PATCH /network/l3-networks/l3-network/{network-id}

update an existing l3-network

+
DELETE /network/l3-networks/l3-network/{network-id}

delete an existing l3-network

+
GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

returns ctag-assignments

+
GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

returns ctag-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

create or update an existing ctag-assignment

+
PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

update an existing ctag-assignment

+
DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

delete an existing ctag-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

delete an existing relationship

+
PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

returns segmentation-assignments

+
GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

returns segmentation-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

create or update an existing segmentation-assignment

+
PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

update an existing segmentation-assignment

+
DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

delete an existing segmentation-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/l3-networks/l3-network/{network-id}/subnets

returns subnets

+
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

returns subnet

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

create or update an existing subnet

+
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

update an existing subnet

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

delete an existing subnet

+
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

returns host-routes

+
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

returns host-route

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

create or update an existing host-route

+
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

update an existing host-route

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

delete an existing host-route

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/lag-links

returns lag-links

+
GET /network/lag-links/lag-link/{link-name}

returns lag-link

+
PUT /network/lag-links/lag-link/{link-name}

create or update an existing lag-link

+
PATCH /network/lag-links/lag-link/{link-name}

update an existing lag-link

+
DELETE /network/lag-links/lag-link/{link-name}

delete an existing lag-link

+
PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/logical-links

returns logical-links

+
GET /network/logical-links/logical-link/{link-name}

returns logical-link

+
PUT /network/logical-links/logical-link/{link-name}

create or update an existing logical-link

+
PATCH /network/logical-links/logical-link/{link-name}

update an existing logical-link

+
DELETE /network/logical-links/logical-link/{link-name}

delete an existing logical-link

+
PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/multicast-configurations

returns multicast-configurations

+
GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

returns multicast-configuration

+
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

create or update an existing multicast-configuration

+
PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

update an existing multicast-configuration

+
DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

delete an existing multicast-configuration

+
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/network-policies

returns network-policies

+
GET /network/network-policies/network-policy/{network-policy-id}

returns network-policy

+
PUT /network/network-policies/network-policy/{network-policy-id}

create or update an existing network-policy

+
PATCH /network/network-policies/network-policy/{network-policy-id}

update an existing network-policy

+
DELETE /network/network-policies/network-policy/{network-policy-id}

delete an existing network-policy

+
PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces

returns newvces

+
GET /network/newvces/newvce/{vnf-id2}

returns newvce

+
PUT /network/newvces/newvce/{vnf-id2}

create or update an existing newvce

+
PATCH /network/newvces/newvce/{vnf-id2}

update an existing newvce

+
DELETE /network/newvces/newvce/{vnf-id2}

delete an existing newvce

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces

returns l-interfaces

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

delete an existing relationship

+
GET /network/physical-links

returns physical-links

+
GET /network/physical-links/physical-link/{link-name}

returns physical-link

+
PUT /network/physical-links/physical-link/{link-name}

create or update an existing physical-link

+
PATCH /network/physical-links/physical-link/{link-name}

update an existing physical-link

+
DELETE /network/physical-links/physical-link/{link-name}

delete an existing physical-link

+
PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs

returns pnfs

+
GET /network/pnfs/pnf/{pnf-name}

returns pnf

+
PUT /network/pnfs/pnf/{pnf-name}

create or update an existing pnf

+
PATCH /network/pnfs/pnf/{pnf-name}

update an existing pnf

+
DELETE /network/pnfs/pnf/{pnf-name}

delete an existing pnf

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

returns lag-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces

returns p-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

returns p-interface

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/route-table-references

returns route-table-references

+
GET /network/route-table-references/route-table-reference/{route-table-reference-id}

returns route-table-reference

+
PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

create or update an existing route-table-reference

+
PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

update an existing route-table-reference

+
DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

delete an existing route-table-reference

+
PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/site-pair-sets

returns site-pair-sets

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

returns site-pair-set

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

create or update an existing site-pair-set

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

update an existing site-pair-set

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

delete an existing site-pair-set

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

returns routing-instances

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

returns routing-instance

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

create or update an existing routing-instance

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

update an existing routing-instance

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

delete an existing routing-instance

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

returns site-pairs

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

returns site-pair

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

create or update an existing site-pair

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

update an existing site-pair

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

delete an existing site-pair

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

returns classes-of-service

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

returns class-of-service

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

create or update an existing class-of-service

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

update an existing class-of-service

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

delete an existing class-of-service

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

delete an existing relationship

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vces

returns vces

+
GET /network/vces/vce/{vnf-id}

returns vce

+
PUT /network/vces/vce/{vnf-id}

create or update an existing vce

+
PATCH /network/vces/vce/{vnf-id}

update an existing vce

+
DELETE /network/vces/vce/{vnf-id}

delete an existing vce

+
GET /network/vces/vce/{vnf-id}/entitlements

returns entitlements

+
GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

+
PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

+
PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement

+
DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

+
PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /network/vces/vce/{vnf-id}/licenses

returns licenses

+
GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

returns license

+
PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

+
PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license

+
DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

+
PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /network/vces/vce/{vnf-id}/port-groups

returns port-groups

+
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

returns port-group

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

create or update an existing port-group

+
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

update an existing port-group

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

delete an existing port-group

+
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

returns cvlan-tags

+
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

returns cvlan-tag-entry

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

create or update an existing cvlan-tag-entry

+
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

update an existing cvlan-tag-entry

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

delete an existing cvlan-tag-entry

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vnfcs

returns vnfcs

+
GET /network/vnfcs/vnfc/{vnfc-name}

returns vnfc

+
PUT /network/vnfcs/vnfc/{vnfc-name}

create or update an existing vnfc

+
PATCH /network/vnfcs/vnfc/{vnfc-name}

update an existing vnfc

+
DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc

+
GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes

returns vpls-pes

+
GET /network/vpls-pes/vpls-pe/{equipment-name}

returns vpls-pe

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}

create or update an existing vpls-pe

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}

update an existing vpls-pe

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}

delete an existing vpls-pe

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

returns lag-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

returns p-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

returns p-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpn-bindings

returns vpn-bindings

+
GET /network/vpn-bindings/vpn-binding/{vpn-id}

returns vpn-binding

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}

create or update an existing vpn-binding

+
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

update an existing vpn-binding

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

delete an existing vpn-binding

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

returns route-targets

+
GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

returns route-target

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

create or update an existing route-target

+
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

update an existing route-target

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

delete an existing route-target

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

delete an existing relationship

+
GET /network/zones

returns zones

+
GET /network/zones/zone/{zone-id}

returns zone

+
PUT /network/zones/zone/{zone-id}

create or update an existing zone

+
PATCH /network/zones/zone/{zone-id}

update an existing zone

+
DELETE /network/zones/zone/{zone-id}

delete an existing zone

+
PUT /network/zones/zone/{zone-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

delete an existing relationship

+
+ + + + +

Paths

+ + + +
+
+
returns connectors
+

GET /business/connectors

+ Tags: + Business +
+
+
+

returns connectors

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns connector
+

GET /business/connectors/connector/{resource-instance-id}

+ Tags: + Business +
+
+
+

returns connector

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing connector
+

PUT /business/connectors/connector/{resource-instance-id}

+ Tags: + Business +
+
+
+

create or update an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+

connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing connector
+

PATCH /business/connectors/connector/{resource-instance-id}

+ Tags: + Business +
+
+
+

update an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+

connector object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing connector
+

DELETE /business/connectors/connector/{resource-instance-id}

+ Tags: + Business +
+
+
+

delete an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

GET /business/connectors/connector/{resource-instance-id}/metadata

+ Tags: + Business +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ metaname + + path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

PUT /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns customers
+

GET /business/customers

+ Tags: + Business +
+
+
+

returns customers

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns customer
+

GET /business/customers/customer/{global-customer-id}

+ Tags: + Business +
+
+
+

returns customer

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /customer +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing customer
+

PUT /business/customers/customer/{global-customer-id}

+ Tags: + Business +
+
+
+

create or update an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+

customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)

+

+
+
+
+
+ /customer +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing customer
+

PATCH /business/customers/customer/{global-customer-id}

+ Tags: + Business +
+
+
+

update an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+

customer object that needs to be created or updated.

+

+
+
+
+
+ /customer +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing customer
+

DELETE /business/customers/customer/{global-customer-id}

+ Tags: + Business +
+
+
+

delete an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/customers/customer/{global-customer-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-subscriptions
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions

+ Tags: + Business +
+
+
+

returns service-subscriptions

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-subscription
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

returns service-subscription

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service-subscription
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

create or update an existing service-subscription

+ +
+
+ +

application/json application/xml +

+
+
+

service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service-subscription
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

update an existing service-subscription

+ +
+
+ +

application/json application/xml +

+
+
+

service-subscription object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service-subscription
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

delete an existing service-subscription

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-instances
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances

+ Tags: + Business +
+
+
+

returns service-instances

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-instance
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

+ Tags: + Business +
+
+
+

returns service-instance

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service-instance
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

+ Tags: + Business +
+
+
+

create or update an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+

service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service-instance
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

+ Tags: + Business +
+
+
+

update an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+

service-instance object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service-instance
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

+ Tags: + Business +
+
+
+

delete an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns allotted-resources
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources

+ Tags: + Business +
+
+
+

returns allotted-resources

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns allotted-resource
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+ Tags: + Business +
+
+
+

returns allotted-resource

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ type + +

Generic description of the type of allotted resource.

+
query + string + + +
+ role + +

role in the network that this resource will be providing.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing allotted-resource
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+ Tags: + Business +
+
+
+

create or update an existing allotted-resource

+ +
+
+ +

application/json application/xml +

+
+
+

allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing allotted-resource
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+ Tags: + Business +
+
+
+

update an existing allotted-resource

+ +
+
+ +

application/json application/xml +

+
+
+

allotted-resource object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing allotted-resource
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+ Tags: + Business +
+
+
+

delete an existing allotted-resource

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tunnel-xconnects
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects

+ Tags: + Business +
+
+
+

returns tunnel-xconnects

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ type + +

Generic description of the type of allotted resource.

+
query + string + + +
+ role + +

role in the network that this resource will be providing.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tunnel-xconnect
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

+ Tags: + Business +
+
+
+

returns tunnel-xconnect

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ type + +

Generic description of the type of allotted resource.

+
query + string + + +
+ role + +

role in the network that this resource will be providing.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing tunnel-xconnect
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

+ Tags: + Business +
+
+
+

create or update an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+

tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing tunnel-xconnect
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

+ Tags: + Business +
+
+
+

update an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+

tunnel-xconnect object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing tunnel-xconnect
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}

+ Tags: + Business +
+
+
+

delete an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata

+ Tags: + Business +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ metaname + + path + string + + + +
+ subscriber-name + +

Subscriber name, an alternate way to retrieve a customer.

+
query + string + + +
+ subscriber-type + +

Subscriber type, a way to provide VID with only the INFRA customers.

+
query + string + + +
+ service-instance-name + +

This field will store a name assigned to the service-instance.

+
query + string + + +
+ environment-context + +

This field will store the environment context assigned to the service-instance.

+
query + string + + +
+ workload-context + +

This field will store the workload context assigned to the service-instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ service-instance-location-id + +

An identifier that customers assign to the location where this service is being used.

+
query + string + + +
+ orchestration-status + +

Orchestration status of this service.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+ service-type + +

Value defined by orchestration to identify this service across ECOMP.

+
path + string + + + +
+ service-instance-id + +

Uniquely identifies this instance of a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lines-of-business
+

GET /business/lines-of-business

+ Tags: + Business +
+
+
+

returns lines-of-business

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns line-of-business
+

GET /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

returns line-of-business

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing line-of-business
+

PUT /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

create or update an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+

line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing line-of-business
+

PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

update an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+

line-of-business object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing line-of-business
+

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

delete an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns owning-entities
+

GET /business/owning-entities

+ Tags: + Business +
+
+
+

returns owning-entities

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns owning-entity
+

GET /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

returns owning-entity

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing owning-entity
+

PUT /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

create or update an existing owning-entity

+ +
+
+ +

application/json application/xml +

+
+
+

owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing owning-entity
+

PATCH /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

update an existing owning-entity

+ +
+
+ +

application/json application/xml +

+
+
+

owning-entity object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing owning-entity
+

DELETE /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

delete an existing owning-entity

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns platforms
+

GET /business/platforms

+ Tags: + Business +
+
+
+

returns platforms

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns platform
+

GET /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

returns platform

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /platform +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing platform
+

PUT /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

create or update an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+

platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)

+

+
+
+
+
+ /platform +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing platform
+

PATCH /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

update an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+

platform object that needs to be created or updated.

+

+
+
+
+
+ /platform +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing platform
+

DELETE /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

delete an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/platforms/platform/{platform-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns projects
+

GET /business/projects

+ Tags: + Business +
+
+
+

returns projects

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /projects +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns project
+

GET /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

returns project

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /project +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing project
+

PUT /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

create or update an existing project

+ +
+
+ +

application/json application/xml +

+
+
+

project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)

+

+
+
+
+
+ /project +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing project
+

PATCH /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

update an existing project

+ +
+
+ +

application/json application/xml +

+
+
+

project object that needs to be created or updated.

+

+
+
+
+
+ /project +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing project
+

DELETE /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

delete an existing project

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /business/projects/project/{project-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /business/projects/project/{project-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cloud-regions
+

GET /cloud-infrastructure/cloud-regions

+ Tags: + CloudInfrastructure +
+
+
+

returns cloud-regions

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cloud-region
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns cloud-region

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing cloud-region
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing cloud-region

+ +
+
+ +

application/json application/xml +

+
+
+

cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing cloud-region
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing cloud-region

+ +
+
+ +

application/json application/xml +

+
+
+

cloud-region object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing cloud-region
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing cloud-region

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns availability-zones
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones

+ Tags: + CloudInfrastructure +
+
+
+

returns availability-zones

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns availability-zone
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns availability-zone

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing availability-zone
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing availability-zone

+ +
+
+ +

application/json application/xml +

+
+
+

availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing availability-zone
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing availability-zone

+ +
+
+ +

application/json application/xml +

+
+
+

availability-zone object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing availability-zone
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing availability-zone

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns dvs-switches
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches

+ Tags: + CloudInfrastructure +
+
+
+

returns dvs-switches

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns dvs-switch
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns dvs-switch

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ switch-name + +

DVS switch name

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ vcenter-url + +

URL used to reach the vcenter

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing dvs-switch
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing dvs-switch

+ +
+
+ +

application/json application/xml +

+
+
+

dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ switch-name + +

DVS switch name

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing dvs-switch
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing dvs-switch

+ +
+
+ +

application/json application/xml +

+
+
+

dvs-switch object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ switch-name + +

DVS switch name

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing dvs-switch
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing dvs-switch

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ switch-name + +

DVS switch name

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ switch-name + +

DVS switch name

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ switch-name + +

DVS switch name

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns flavors
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors

+ Tags: + CloudInfrastructure +
+
+
+

returns flavors

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /flavors +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns flavor
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns flavor

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ flavor-name + +

Flavor name

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /flavor +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing flavor
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing flavor

+ +
+
+ +

application/json application/xml +

+
+
+

flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

+
+
+
+
+ /flavor +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing flavor
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing flavor

+ +
+
+ +

application/json application/xml +

+
+
+

flavor object that needs to be created or updated.

+

+
+
+
+
+ /flavor +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing flavor
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing flavor

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns group-assignments
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

+ Tags: + CloudInfrastructure +
+
+
+

returns group-assignments

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns group-assignment
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns group-assignment

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ group-type + +

Group type - the type of group this instance refers to

+
query + string + + +
+ group-name + +

Group name - name assigned to the group

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing group-assignment
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing group-assignment
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing group-assignment
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns images
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images

+ Tags: + CloudInfrastructure +
+
+
+

returns images

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /images +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns image
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns image

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ image-name + +

Image name

+
query + string + + +
+ application + +

The application that the image instantiates.

+
query + string + + +
+ application-vendor + +

The vendor of the application.

+
query + string + + +
+ application-version + +

The version of the application.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /image +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing image
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing image

+ +
+
+ +

application/json application/xml +

+
+
+

image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

+

+
+
+
+
+ /image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing image
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing image

+ +
+
+ +

application/json application/xml +

+
+
+

image object that needs to be created or updated.

+

+
+
+
+
+ /image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing image
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing image

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata

+ Tags: + CloudInfrastructure +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ image-name + +

Image name

+
query + string + + +
+ application + +

The application that the image instantiates.

+
query + string + + +
+ application-vendor + +

The vendor of the application.

+
query + string + + +
+ application-version + +

The version of the application.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+ Tags: + CloudInfrastructure +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ metaname + + path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ image-name + +

Image name

+
query + string + + +
+ application + +

The application that the image instantiates.

+
query + string + + +
+ application-vendor + +

The vendor of the application.

+
query + string + + +
+ application-version + +

The version of the application.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns oam-networks
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks

+ Tags: + CloudInfrastructure +
+
+
+

returns oam-networks

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns oam-network
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

returns oam-network

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ network-name + +

Name of the network.

+
query + string + + +
+ cvlan-tag + +

cvlan-id

+
query + integer + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing oam-network
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+

oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing oam-network
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+

oam-network object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing oam-network
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns snapshots
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots

+ Tags: + CloudInfrastructure +
+
+
+

returns snapshots

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns snapshot
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns snapshot

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ snapshot-name + +

Snapshot name

+
query + string + + +
+ application + +

The application that the image instantiates.

+
query + string + + +
+ application-vendor + +

The vendor of the application.

+
query + string + + +
+ application-version + +

The version of the application.

+
query + string + + +
+ prev-snapshot-id + +

This field contains the UUID of the previous snapshot (if any).

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /snapshot +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing snapshot
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing snapshot

+ +
+
+ +

application/json application/xml +

+
+
+

snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

+

+
+
+
+
+ /snapshot +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing snapshot
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing snapshot

+ +
+
+ +

application/json application/xml +

+
+
+

snapshot object that needs to be created or updated.

+

+
+
+
+
+ /snapshot +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing snapshot
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing snapshot

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tenants
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

+ Tags: + CloudInfrastructure +
+
+
+

returns tenants

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /tenants +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tenant
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns tenant

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /tenant +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing tenant
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing tenant

+ +
+
+ +

application/json application/xml +

+
+
+

tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

+
+
+
+
+ /tenant +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing tenant
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing tenant

+ +
+
+ +

application/json application/xml +

+
+
+

tenant object that needs to be created or updated.

+

+
+
+
+
+ /tenant +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing tenant
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing tenant

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vservers
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

+ Tags: + CloudInfrastructure +
+
+
+

returns vservers

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vservers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vserver
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns vserver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vserver +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vserver
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vserver

+ +
+
+ +

application/json application/xml +

+
+
+

vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

+
+
+
+
+ /vserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vserver
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vserver

+ +
+
+ +

application/json application/xml +

+
+
+

vserver object that needs to be created or updated.

+

+
+
+
+
+ /vserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vserver
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vserver

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns volumes
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

+ Tags: + CloudInfrastructure +
+
+
+

returns volumes

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volumes +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns volume
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns volume

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ tenant-name + +

Readable name of tenant

+
query + string + + +
+ tenant-context + +

This field will store the tenant context.

+
query + string + + +
+ vserver-name + +

Name of vserver

+
query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volume +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing volume
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing volume

+ +
+
+ +

application/json application/xml +

+
+
+

volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

+
+
+
+
+ /volume +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing volume
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing volume

+ +
+
+ +

application/json application/xml +

+
+
+

volume object that needs to be created or updated.

+

+
+
+
+
+ /volume +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing volume
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing volume

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vip-ipv4-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns vip-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv4-address + +

IP address

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vip-ipv4-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vip-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vip-ipv4-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vip-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

vip-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vip-ipv4-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vip-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vip-ipv6-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns vip-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv6-address + +

IP address

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vip-ipv6-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vip-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vip-ipv6-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vip-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

vip-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vip-ipv6-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vip-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ vip-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns volume-groups
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

+ Tags: + CloudInfrastructure +
+
+
+

returns volume-groups

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns volume-group
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns volume-group

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

+
path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+
query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
query + string + + +
+ volume-group-name + +

Name of the volume group.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this volume-group

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing volume-group
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing volume-group

+ +
+
+ +

application/json application/xml +

+
+
+

volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing volume-group
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing volume-group

+ +
+
+ +

application/json application/xml +

+
+
+

volume-group object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing volume-group
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing volume-group

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns complexes
+

GET /cloud-infrastructure/complexes

+ Tags: + CloudInfrastructure +
+
+
+

returns complexes

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns complex
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns complex

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ data-center-code + +

Data center code which can be an alternate way to identify a complex

+
query + string + + +
+ complex-name + +

Gamma complex name for LCP instance.

+
query + string + + +
+ identity-url + +

URL of the keystone identity service

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /complex +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing complex
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing complex

+ +
+
+ +

application/json application/xml +

+
+
+

complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+
+ /complex +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing complex
+

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing complex

+ +
+
+ +

application/json application/xml +

+
+
+

complex object that needs to be created or updated.

+

+
+
+
+
+ /complex +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing complex
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing complex

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-pools
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

+ Tags: + CloudInfrastructure +
+
+
+

returns ctag-pools

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ data-center-code + +

Data center code which can be an alternate way to identify a complex

+
query + string + + +
+ complex-name + +

Gamma complex name for LCP instance.

+
query + string + + +
+ identity-url + +

URL of the keystone identity service

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-pool
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns ctag-pool

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ target-pe + +

The Target provider edge router

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone

+
path + string + + + +
+ data-center-code + +

Data center code which can be an alternate way to identify a complex

+
query + string + + +
+ complex-name + +

Gamma complex name for LCP instance.

+
query + string + + +
+ identity-url + +

URL of the keystone identity service

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing ctag-pool
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing ctag-pool

+ +
+
+ +

application/json application/xml +

+
+
+

ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ target-pe + +

The Target provider edge router

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing ctag-pool
+

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing ctag-pool

+ +
+
+ +

application/json application/xml +

+
+
+

ctag-pool object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ target-pe + +

The Target provider edge router

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ctag-pool
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing ctag-pool

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ target-pe + +

The Target provider edge router

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ target-pe + +

The Target provider edge router

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+ target-pe + +

The Target provider edge router

+
path + string + + + +
+ availability-zone-name + +

Name of the availability zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-profiles
+

GET /cloud-infrastructure/network-profiles

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profiles

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-profile
+

GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profile

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing network-profile
+

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing network-profile

+ +
+
+ +

application/json application/xml +

+
+
+

network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing network-profile
+

PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing network-profile

+ +
+
+ +

application/json application/xml +

+
+
+

network-profile object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing network-profile
+

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing network-profile

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns operational-environments
+

GET /cloud-infrastructure/operational-environments

+ Tags: + CloudInfrastructure +
+
+
+

returns operational-environments

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns operational-environment
+

GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns operational-environment

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing operational-environment
+

PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing operational-environment

+ +
+
+ +

application/json application/xml +

+
+
+

operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing operational-environment
+

PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing operational-environment

+ +
+
+ +

application/json application/xml +

+
+
+

operational-environment object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing operational-environment
+

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing operational-environment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pservers
+

GET /cloud-infrastructure/pservers

+ Tags: + CloudInfrastructure +
+
+
+

returns pservers

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /pservers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pserver
+

GET /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

returns pserver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /pserver +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing pserver
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+

pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)

+

+
+
+
+
+ /pserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing pserver
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+

pserver object that needs to be created or updated.

+

+
+
+
+
+ /pserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing pserver
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing lag-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns p-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing p-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing p-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ pserver-id + +

ID of Pserver

+
query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns virtual-data-centers
+

GET /cloud-infrastructure/virtual-data-centers

+ Tags: + CloudInfrastructure +
+
+
+

returns virtual-data-centers

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns virtual-data-center
+

GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns virtual-data-center

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+
path + string + + + +
+ vdc-name + +

Name of the virtual data center

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing virtual-data-center
+

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+

virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing virtual-data-center
+

PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+

virtual-data-center object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing virtual-data-center
+

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns configurations
+

GET /network/configurations

+ Tags: + Network +
+
+
+

returns configurations

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns configuration
+

GET /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

returns configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing configuration
+

PUT /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

create or update an existing configuration

+ +
+
+ +

application/json application/xml +

+
+
+

configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing configuration
+

PATCH /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

update an existing configuration

+ +
+
+ +

application/json application/xml +

+
+
+

configuration object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing configuration
+

DELETE /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

delete an existing configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns evcs
+

GET /network/configurations/configuration/{configuration-id}/evcs

+ Tags: + Network +
+
+
+

returns evcs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /evcs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns evc
+

GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

returns evc

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /evc +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing evc
+

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

create or update an existing evc

+ +
+
+ +

application/json application/xml +

+
+
+

evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)

+

+
+
+
+
+ /evc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing evc
+

PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

update an existing evc

+ +
+
+ +

application/json application/xml +

+
+
+

evc object that needs to be created or updated.

+

+
+
+
+
+ /evc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing evc
+

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

delete an existing evc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarder-evcs
+

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

+ Tags: + Network +
+
+
+

returns forwarder-evcs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarder-evc
+

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

returns forwarder-evc

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing forwarder-evc
+

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

create or update an existing forwarder-evc

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing forwarder-evc
+

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

update an existing forwarder-evc

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder-evc object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing forwarder-evc
+

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

delete an existing forwarder-evc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

GET /network/configurations/configuration/{configuration-id}/metadata

+ Tags: + Network +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ metaname + + path + string + + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarding-paths
+

GET /network/forwarding-paths

+ Tags: + Network +
+
+
+

returns forwarding-paths

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarding-path
+

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

returns forwarding-path

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ forwarding-path-name + +

Name of the FP

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing forwarding-path
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

create or update an existing forwarding-path

+ +
+
+ +

application/json application/xml +

+
+
+

forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing forwarding-path
+

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

update an existing forwarding-path

+ +
+
+ +

application/json application/xml +

+
+
+

forwarding-path object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing forwarding-path
+

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

delete an existing forwarding-path

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarders
+

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

+ Tags: + Network +
+
+
+

returns forwarders

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ forwarding-path-name + +

Name of the FP

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarder
+

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

returns forwarder

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ sequence + +

Unique ID of this segmentation

+
path + integer + + + +
+ forwarding-path-name + +

Name of the FP

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing forwarder
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

create or update an existing forwarder

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ sequence + +

Unique ID of this segmentation

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing forwarder
+

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

update an existing forwarder

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ sequence + +

Unique ID of this segmentation

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing forwarder
+

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

delete an existing forwarder

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ sequence + +

Unique ID of this segmentation

+
path + integer + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ sequence + +

Unique ID of this segmentation

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+ sequence + +

Unique ID of this segmentation

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns generic-vnfs
+

GET /network/generic-vnfs

+ Tags: + Network +
+
+
+

returns generic-vnfs

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns generic-vnf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

returns generic-vnf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing generic-vnf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

create or update an existing generic-vnf

+ +
+
+ +

application/json application/xml +

+
+
+

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing generic-vnf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

update an existing generic-vnf

+ +
+
+ +

application/json application/xml +

+
+
+

generic-vnf object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing generic-vnf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

delete an existing generic-vnf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlements
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

+ Tags: + Network +
+
+
+

returns entitlements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlement
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns entitlement

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing entitlement
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

create or update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing entitlement
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing entitlement
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing lag-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns licenses
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

+ Tags: + Network +
+
+
+

returns licenses

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns license
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns license

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing license
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

create or update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing license
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated.

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing license
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing license

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vf-modules
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

+ Tags: + Network +
+
+
+

returns vf-modules

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vf-module
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

returns vf-module

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ nf-type + +

Generic description of the type of NF

+
query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+
query + string + + +
+ nf-role + +

role in the network that this model will be providing

+
query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+
query + string + + +
+ vf-module-name + +

Name of vf-module

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance.

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ contrail-service-instance-fqdn + +

the Contrail unique ID for a service-instance

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vf-module
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

create or update an existing vf-module

+ +
+
+ +

application/json application/xml +

+
+
+

vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vf-module
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

update an existing vf-module

+ +
+
+ +

application/json application/xml +

+
+
+

vf-module object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vf-module
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

delete an existing vf-module

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns instance-groups
+

GET /network/instance-groups

+ Tags: + Network +
+
+
+

returns instance-groups

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns instance-group
+

GET /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

returns instance-group

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+
path + string + + + +
+ description + +

Descriptive text to help identify the usage of this instance-group

+
query + string + + +
+ type + +

Only valid value today is lower case ha for high availability

+
query + string + + +
+ sub-type + +

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing instance-group
+

PUT /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

create or update an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+

instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing instance-group
+

PATCH /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

update an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+

instance-group object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing instance-group
+

DELETE /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

delete an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ipsec-configurations
+

GET /network/ipsec-configurations

+ Tags: + Network +
+
+
+

returns ipsec-configurations

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ipsec-configuration
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

returns ipsec-configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing ipsec-configuration
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

create or update an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing ipsec-configuration
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

update an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

ipsec-configuration object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ipsec-configuration
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

delete an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vig-servers
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

+ Tags: + Network +
+
+
+

returns vig-servers

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vig-server
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+ Tags: + Network +
+
+
+

returns vig-server

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vig-server
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+ Tags: + Network +
+
+
+

create or update an existing vig-server

+ +
+
+ +

application/json application/xml +

+
+
+

vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vig-server
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+ Tags: + Network +
+
+
+

update an existing vig-server

+ +
+
+ +

application/json application/xml +

+
+
+

vig-server object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vig-server
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+ Tags: + Network +
+
+
+

delete an existing vig-server

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-networks
+

GET /network/l3-networks

+ Tags: + Network +
+
+
+

returns l3-networks

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-network
+

GET /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

returns l3-network

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-network
+

PUT /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

create or update an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+

l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-network
+

PATCH /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

update an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+

l3-network object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-network
+

DELETE /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

delete an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-assignments
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

+ Tags: + Network +
+
+
+

returns ctag-assignments

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-assignment
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

returns ctag-assignment

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ vlan-id-inner + +

id.

+
path + integer + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing ctag-assignment
+

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

create or update an existing ctag-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ vlan-id-inner + +

id.

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing ctag-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

update an existing ctag-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

ctag-assignment object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ vlan-id-inner + +

id.

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ctag-assignment
+

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

delete an existing ctag-assignment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ vlan-id-inner + +

id.

+
path + integer + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ vlan-id-inner + +

id.

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ vlan-id-inner + +

id.

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns segmentation-assignments
+

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

+ Tags: + Network +
+
+
+

returns segmentation-assignments

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns segmentation-assignment
+

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

returns segmentation-assignment

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing segmentation-assignment
+

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

create or update an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing segmentation-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

update an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

segmentation-assignment object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing segmentation-assignment
+

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

delete an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns subnets
+

GET /network/l3-networks/l3-network/{network-id}/subnets

+ Tags: + Network +
+
+
+

returns subnets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /subnets +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns subnet
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

returns subnet

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ subnet-name + +

Name associated with the subnet.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /subnet +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing subnet
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

create or update an existing subnet

+ +
+
+ +

application/json application/xml +

+
+
+

subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

+

+
+
+
+
+ /subnet +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing subnet
+

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

update an existing subnet

+ +
+
+ +

application/json application/xml +

+
+
+

subnet object that needs to be created or updated.

+

+
+
+
+
+ /subnet +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing subnet
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

delete an existing subnet

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns host-routes
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

+ Tags: + Network +
+
+
+

returns host-routes

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ subnet-name + +

Name associated with the subnet.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns host-route
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+ Tags: + Network +
+
+
+

returns host-route

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ host-route-id + +

host-route id

+
path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

+
query + string + + +
+ network-role + +

Role the network plans - who defines these values?

+
query + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
query + string + + +
+ subnet-name + +

Name associated with the subnet.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing host-route
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+ Tags: + Network +
+
+
+

create or update an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ host-route-id + +

host-route id

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing host-route
+

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+ Tags: + Network +
+
+
+

update an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ host-route-id + +

host-route id

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing host-route
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+ Tags: + Network +
+
+
+

delete an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ host-route-id + +

host-route id

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ host-route-id + +

host-route id

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+ host-route-id + +

host-route id

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
returns multicast-configurations
+

GET /network/multicast-configurations

+ Tags: + Network +
+
+
+

returns multicast-configurations

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns multicast-configuration
+

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

returns multicast-configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing multicast-configuration
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

create or update an existing multicast-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing multicast-configuration
+

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

update an existing multicast-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

multicast-configuration object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing multicast-configuration
+

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

delete an existing multicast-configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-policies
+

GET /network/network-policies

+ Tags: + Network +
+
+
+

returns network-policies

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-policy
+

GET /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

returns network-policy

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+
path + string + + + +
+ network-policy-fqdn + +

Contrail FQDN for the policy

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing network-policy
+

PUT /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

create or update an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+

network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing network-policy
+

PATCH /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

update an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+

network-policy object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing network-policy
+

DELETE /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

delete an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns newvces
+

GET /network/newvces

+ Tags: + Network +
+
+
+

returns newvces

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /newvces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns newvce
+

GET /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

returns newvce

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /newvce +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing newvce
+

PUT /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

create or update an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+

newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)

+

+
+
+
+
+ /newvce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing newvce
+

PATCH /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

update an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+

newvce object that needs to be created or updated.

+

+
+
+
+
+ /newvce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing newvce
+

DELETE /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

delete an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+
returns pnfs
+

GET /network/pnfs

+ Tags: + Network +
+
+
+

returns pnfs

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /pnfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pnf
+

GET /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

returns pnf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /pnf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing pnf
+

PUT /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

create or update an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+

pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)

+

+
+
+
+
+ /pnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing pnf
+

PATCH /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

update an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+

pnf object that needs to be created or updated.

+

+
+
+
+
+ /pnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing pnf
+

DELETE /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

delete an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-interface
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing lag-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns p-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing p-interface
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing p-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + Network +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

returns sriov-pf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-table-references
+

GET /network/route-table-references

+ Tags: + Network +
+
+
+

returns route-table-references

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-table-reference
+

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

returns route-table-reference

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+ route-table-reference-fqdn + +

FQDN entry in the route table.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing route-table-reference
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

create or update an existing route-table-reference

+ +
+
+ +

application/json application/xml +

+
+
+

route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing route-table-reference
+

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

update an existing route-table-reference

+ +
+
+ +

application/json application/xml +

+
+
+

route-table-reference object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing route-table-reference
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

delete an existing route-table-reference

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pair-sets
+

GET /network/site-pair-sets

+ Tags: + Network +
+
+
+

returns site-pair-sets

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pair-set
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

returns site-pair-set

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing site-pair-set
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

create or update an existing site-pair-set

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing site-pair-set
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

update an existing site-pair-set

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair-set object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing site-pair-set
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

delete an existing site-pair-set

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns routing-instances
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

+ Tags: + Network +
+
+
+

returns routing-instances

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns routing-instance
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

returns routing-instance

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing routing-instance
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

create or update an existing routing-instance

+ +
+
+ +

application/json application/xml +

+
+
+

routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing routing-instance
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

update an existing routing-instance

+ +
+
+ +

application/json application/xml +

+
+
+

routing-instance object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing routing-instance
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

delete an existing routing-instance

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pairs
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

+ Tags: + Network +
+
+
+

returns site-pairs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pair
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

returns site-pair

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing site-pair
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

create or update an existing site-pair

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing site-pair
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

update an existing site-pair

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing site-pair
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

delete an existing site-pair

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns classes-of-service
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

+ Tags: + Network +
+
+
+

returns classes-of-service

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns class-of-service
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

returns class-of-service

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ cos + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing class-of-service
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

create or update an existing class-of-service

+ +
+
+ +

application/json application/xml +

+
+
+

class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ cos + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing class-of-service
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

update an existing class-of-service

+ +
+
+ +

application/json application/xml +

+
+
+

class-of-service object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ cos + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing class-of-service
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

delete an existing class-of-service

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ cos + +

unique identifier of probe

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ cos + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+ cos + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+
path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+
path + string + + + +
+ site-pair-id + +

unique identifier of probe

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vces
+

GET /network/vces

+ Tags: + Network +
+
+
+

returns vces

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vce
+

GET /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

returns vce

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vce +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vce
+

PUT /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

create or update an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+

vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)

+

+
+
+
+
+ /vce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vce
+

PATCH /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

update an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+

vce object that needs to be created or updated.

+

+
+
+
+
+ /vce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vce
+

DELETE /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

delete an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlements
+

GET /network/vces/vce/{vnf-id}/entitlements

+ Tags: + Network +
+
+
+

returns entitlements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlement
+

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns entitlement

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing entitlement
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

create or update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing entitlement
+

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing entitlement
+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns licenses
+

GET /network/vces/vce/{vnf-id}/licenses

+ Tags: + Network +
+
+
+

returns licenses

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns license
+

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns license

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing license
+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

create or update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing license
+

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated.

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing license
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing license

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns port-groups
+

GET /network/vces/vce/{vnf-id}/port-groups

+ Tags: + Network +
+
+
+

returns port-groups

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns port-group
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

returns port-group

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+ port-group-id + +

Unique ID for port group in vmware

+
query + string + + +
+ switch-name + +

DVS or standard switch name (should be non-null for port groups associated with DVS)

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing port-group
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

create or update an existing port-group

+ +
+
+ +

application/json application/xml +

+
+
+

port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing port-group
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

update an existing port-group

+ +
+
+ +

application/json application/xml +

+
+
+

port-group object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing port-group
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

delete an existing port-group

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cvlan-tags
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

+ Tags: + Network +
+
+
+

returns cvlan-tags

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+ port-group-id + +

Unique ID for port group in vmware

+
query + string + + +
+ switch-name + +

DVS or standard switch name (should be non-null for port groups associated with DVS)

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cvlan-tag-entry
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

returns cvlan-tag-entry

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+
path + integer + + + +
+ vnf-name + +

Name of VNF.

+
query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+
query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+
query + string + + +
+ port-group-id + +

Unique ID for port group in vmware

+
query + string + + +
+ switch-name + +

DVS or standard switch name (should be non-null for port groups associated with DVS)

+
query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing cvlan-tag-entry
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

create or update an existing cvlan-tag-entry

+ +
+
+ +

application/json application/xml +

+
+
+

cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing cvlan-tag-entry
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

update an existing cvlan-tag-entry

+ +
+
+ +

application/json application/xml +

+
+
+

cvlan-tag-entry object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing cvlan-tag-entry
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

delete an existing cvlan-tag-entry

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+
path + integer + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+
path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-id + +

Unique ID of the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnfcs
+

GET /network/vnfcs

+ Tags: + Network +
+
+
+

returns vnfcs

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vnfcs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnfc
+

GET /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

returns vnfc

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ nfc-naming-code + +

Short code that is used in naming instances of the item being modeled

+
query + string + + +
+ nfc-function + +

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+
query + string + + +
+ prov-status + +

prov status of this vnfc

+
query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vnfc +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vnfc
+

PUT /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

create or update an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+

vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)

+

+
+
+
+
+ /vnfc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vnfc
+

PATCH /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

update an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+

vnfc object that needs to be created or updated.

+

+
+
+
+
+ /vnfc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vnfc
+

DELETE /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

delete an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ nfc-naming-code + +

Short code that is used in naming instances of the item being modeled

+
query + string + + +
+ nfc-function + +

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+
query + string + + +
+ prov-status + +

prov status of this vnfc

+
query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ nfc-naming-code + +

Short code that is used in naming instances of the item being modeled

+
query + string + + +
+ nfc-function + +

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+
query + string + + +
+ prov-status + +

prov status of this vnfc

+
query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+
query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+
query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+
query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vpls-pes
+

GET /network/vpls-pes

+ Tags: + Network +
+
+
+

returns vpls-pes

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vpls-pes +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vpls-pe
+

GET /network/vpls-pes/vpls-pe/{equipment-name}

+ Tags: + Network +
+
+
+

returns vpls-pe

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vpls-pe +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vpls-pe
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}

+ Tags: + Network +
+
+
+

create or update an existing vpls-pe

+ +
+
+ +

application/json application/xml +

+
+
+

vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)

+

+
+
+
+
+ /vpls-pe +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vpls-pe
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

+ Tags: + Network +
+
+
+

update an existing vpls-pe

+ +
+
+ +

application/json application/xml +

+
+
+

vpls-pe object that needs to be created or updated.

+

+
+
+
+
+ /vpls-pe +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vpls-pe
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

+ Tags: + Network +
+
+
+

delete an existing vpls-pe

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing lag-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns p-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing p-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing p-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+ interface-id + +

ID of interface

+
query + string + + +
+ macaddr + +

MAC address for the interface

+
query + string + + +
+ network-name + +

Name of the network

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+
query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+
query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+
query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + Network +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

returns sriov-pf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vpn-bindings
+

GET /network/vpn-bindings

+ Tags: + Network +
+
+
+

returns vpn-bindings

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vpn-binding
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

returns vpn-binding

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ vpn-name + +

VPN Name

+
query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vpn-binding
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

create or update an existing vpn-binding

+ +
+
+ +

application/json application/xml +

+
+
+

vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vpn-binding
+

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

update an existing vpn-binding

+ +
+
+ +

application/json application/xml +

+
+
+

vpn-binding object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vpn-binding
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

delete an existing vpn-binding

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-targets
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

+ Tags: + Network +
+
+
+

returns route-targets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ vpn-name + +

VPN Name

+
query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-target
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

returns route-target

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+ vpn-name + +

VPN Name

+
query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing route-target
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

create or update an existing route-target

+ +
+
+ +

application/json application/xml +

+
+
+

route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing route-target
+

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

update an existing route-target

+ +
+
+ +

application/json application/xml +

+
+
+

route-target object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing route-target
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

delete an existing route-target

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns zones
+

GET /network/zones

+ Tags: + Network +
+
+
+

returns zones

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /zones +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns zone
+

GET /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

returns zone

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
+ design-type + +

Design of zone [Medium/Largeā€¦]

+
query + string + + +
+ zone-context + +

Context of zone [production/test]

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /zone +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing zone
+

PUT /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

create or update an existing zone

+ +
+
+ +

application/json application/xml +

+
+
+

zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)

+

+
+
+
+
+ /zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing zone
+

PATCH /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

update an existing zone

+ +
+
+ +

application/json application/xml +

+
+
+

zone object that needs to be created or updated.

+

+
+
+
+
+ /zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing zone
+

DELETE /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

delete an existing zone

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns models
+

GET /service-design-and-creation/models

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns models

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /models +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model
+

GET /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model
+

PUT /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model

+ +
+
+ +

application/json application/xml +

+
+
+

model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)

+

+
+
+
+
+ /model +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model

+ +
+
+ +

application/json application/xml +

+
+
+

model object that needs to be created or updated.

+

+
+
+
+
+ /model +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-vers
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-vers

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-ver
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-ver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model-ver
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model-ver

+ +
+
+ +

application/json application/xml +

+
+
+

model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model-ver
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model-ver

+ +
+
+ +

application/json application/xml +

+
+
+

model-ver object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model-ver
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model-ver

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ metaname + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-elements
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-elements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-element
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-element

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model-element
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model-element

+ +
+
+ +

application/json application/xml +

+
+
+

model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model-element
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model-element

+ +
+
+ +

application/json application/xml +

+
+
+

model-element object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model-element
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model-element

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-constraints
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-constraints

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-constraint
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-constraint

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model-constraint
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model-constraint
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

model-constraint object that needs to be created or updated.

+

+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model-constraint
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model-constraint

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns constrained-element-sets
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns constrained-element-sets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns constrained-element-set
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns constrained-element-set

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing constrained-element-set
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing constrained-element-set

+ +
+
+ +

application/json application/xml +

+
+
+

constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing constrained-element-set
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing constrained-element-set

+ +
+
+ +

application/json application/xml +

+
+
+

constrained-element-set object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing constrained-element-set
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing constrained-element-set

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns element-choice-sets
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns element-choice-sets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns element-choice-set
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns element-choice-set

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+
query + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+
query + string + + +
+ model-version + +

Version

+
query + string + + +
+ distribution-status + +

Distribution Status

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing element-choice-set
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing element-choice-set

+ +
+
+ +

application/json application/xml +

+
+
+

element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing element-choice-set
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing element-choice-set

+ +
+
+ +

application/json application/xml +

+
+
+

element-choice-set object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing element-choice-set
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing element-choice-set

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-queries
+

GET /service-design-and-creation/named-queries

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-queries

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-query
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-query

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing named-query
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+

named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing named-query
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+

named-query object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing named-query
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-query-elements
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-query-elements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-query-element
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-query-element

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing named-query-element
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+

named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing named-query-element
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+

named-query-element object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing named-query-element
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns property-constraints
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns property-constraints

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns property-constraint
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns property-constraint

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing property-constraint
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing property-constraint
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

property-constraint object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing property-constraint
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-capabilities
+

GET /service-design-and-creation/service-capabilities

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns service-capabilities

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-capability
+

GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns service-capability

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service-capability
+

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+

service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service-capability
+

PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+

service-capability object that needs to be created or updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service-capability
+

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns services
+

GET /service-design-and-creation/services

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns services

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /services +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service
+

GET /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns service

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ service-description + +

Description of the service

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /service +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service
+

PUT /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing service

+ +
+
+ +

application/json application/xml +

+
+
+

service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)

+

+
+
+
+
+ /service +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service
+

PATCH /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing service

+ +
+
+ +

application/json application/xml +

+
+
+

service object that needs to be created or updated.

+

+
+
+
+
+ /service +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service
+

DELETE /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing service

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnf-images
+

GET /service-design-and-creation/vnf-images

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns vnf-images

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnf-image
+

GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns vnf-image

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+
path + string + + + +
+ application + +

The application that the image instantiates.

+
query + string + + +
+ application-vendor + +

The vendor of the application.

+
query + string + + +
+ application-version + +

The version of the application.

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vnf-image
+

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+

vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vnf-image
+

PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+

vnf-image object that needs to be created or updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vnf-image
+

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +

Schema definitions

+ +
+
+

aai-internal: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

action: + object + + + +

+
+
+ +
+
+
+ action-type: + string + + +
+
+
+ +
+
+
+ action-data: + object[] + + +
+
+ +
+ +
+ action-data + + + +
+ +
+
+
+
+
+
+
+
+
+

action-data: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

actions: + object + + + +

+
+
+
+

APIs that are more action related than REST (e.g., notify, update).

+ +
+ +
+
+
+ update: + object + + +
+
+ +
+ +
+ update + + + +
+ +
+
+
+
+ notify: + object + + +
+
+ +
+ +
+ notify + + + +
+ +
+
+
+
+
+
+
+
+
+

allotted-resource: + object + + + +

+
+
+
+

Represents a slice or partial piece of a resource that gets separately allotted

+ +
    +
  • TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
  • +
  • TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
  • +
  • TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
  • +
  • TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
  • +
  • TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
  • +
  • TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
  • +
  • TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
  • +
  • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
  • +
  • TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
  • +
  • FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
  • +
  • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ +
+ +
+
+
+ id: + string + + + +
+
+

Allotted Resource id UUID assigned to this instance.

+
+ +
+
+
+ description: + string + + +
+
+

The descriptive information assigned to this allotted resource instance

+
+ +
+
+
+ selflink: + string + + +
+
+

Link back to more information in the controller

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational

+
+ +
+
+
+ type: + string + + +
+
+

Generic description of the type of allotted resource.

+
+ +
+
+
+ role: + string + + +
+
+

role in the network that this resource will be providing.

+
+ +
+
+
+ tunnel-xconnects: + object[] + + +
+
+ +
+ +
+ tunnel-xconnect + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

allotted-resources: + object + + + +

+
+
+
+

This object is used to store slices of services being offered

+ +
+ +
+
+
+ allotted-resource: + object[] + + +
+
+ +
+ +
+ allotted-resource + + + +
+ +
+
+
+
+
+
+
+
+
+

availability-zone: + object + + + +

+
+
+
+

Availability zone, a collection of compute hosts/pservers

+ +
    +
  • TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
  • +
  • TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
  • +
  • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
  • +
  • FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
  • +
  • FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
  • +
  • AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+ +
+ +
+
+
+ availability-zone-name: + string + + + +
+
+

Name of the availability zone. Unique across a cloud region

+
+ +
+
+
+ hypervisor-type: + string + + + +
+
+

Type of hypervisor. Source of truth should define valid values.

+
+ +
+
+
+ operational-status: + string + + +
+
+

State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

availability-zones: + object + + + +

+
+
+
+

Collection of availability zones

+ +
+ +
+
+
+ availability-zone: + object[] + + +
+
+ +
+ +
+ availability-zone + + + +
+ +
+
+
+
+
+
+
+
+
+

az-and-dvs-switches: + object + + + +

+
+
+ +
+
+
+ dvs-switches: + object + + +
+
+ +
+ +
+ dvs-switches + + + +
+ +
+
+
+
+ availability-zone: + object + + +
+
+ +
+ +
+ availability-zone + + + +
+ +
+
+
+
+
+
+
+
+
+

business: + object + + + +

+
+
+
+

Namespace for business related constructs

+ +
+ +
+
+
+ connectors: + object[] + + +
+
+ +
+ +
+ connector + + + +
+ +
+
+
+
+ customers: + object[] + + +
+
+ +
+ +
+ customer + + + +
+ +
+
+
+
+ lines-of-business: + object[] + + +
+
+ +
+ +
+ line-of-business + + + +
+ +
+
+
+
+ owning-entities: + object[] + + +
+
+ +
+ +
+ owning-entity + + + +
+ +
+
+
+
+ platforms: + object[] + + +
+
+ +
+ +
+ platform + + + +
+ +
+
+
+
+ projects: + object[] + + +
+
+ +
+ +
+ project + + + +
+ +
+
+
+
+
+
+
+
+
+

class-of-service: + object + + + +

+
+
+
+ +
    +
  • TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ +
+ +
+
+
+ cos: + string + + + +
+
+

unique identifier of probe

+
+ +
+
+
+ probe-id: + string + + +
+
+

identifier of probe

+
+ +
+
+
+ probe-type: + string + + +
+
+

type of probe

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

classes-of-service: + object + + + +

+
+
+
+

class-of-service of probe

+ +
+ +
+
+
+ class-of-service: + object[] + + +
+
+ +
+ +
+ class-of-service + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-infrastructure: + object + + + +

+
+
+
+

Namespace for cloud infrastructure.

+ +
+ +
+
+
+ complexes: + object[] + + +
+
+ +
+ +
+ complex + + + +
+ +
+
+
+
+ cloud-regions: + object[] + + +
+
+ +
+ +
+ cloud-region + + + +
+ +
+
+
+
+ network-profiles: + object[] + + +
+
+ +
+ +
+ network-profile + + + +
+ +
+
+
+
+ pservers: + object[] + + +
+
+ +
+ +
+ pserver + + + +
+ +
+
+
+
+ virtual-data-centers: + object[] + + +
+
+ +
+ +
+ virtual-data-center + + + +
+ +
+
+
+
+ operational-environments: + object[] + + +
+
+ +
+ +
+ operational-environment + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-region: + object + + + +

+
+
+
+

cloud-region designates an installation of a cloud cluster or region or instantiation.

+ +
    +
  • TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
  • +
  • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
  • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
  • +
  • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
  • +
  • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
  • +
  • CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ +
+ +
+
+
+ cloud-owner: + string + + + +
+
+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
+ +
+
+
+ cloud-region-id: + string + + + +
+
+

Identifier used by the vendor for the region. Second part of composite key

+
+ +
+
+
+ cloud-type: + string + + +
+
+

Type of the cloud (e.g., openstack)

+
+ +
+
+
+ owner-defined-type: + string + + +
+
+

Cloud-owner defined type indicator (e.g., dcp, lcp)

+
+ +
+
+
+ cloud-region-version: + string + + +
+
+

Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

+
+ +
+
+
+ identity-url: + string + + +
+
+

URL of the keystone identity service

+
+ +
+
+
+ cloud-zone: + string + + +
+
+

Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

+
+ +
+
+
+ complex-name: + string + + +
+
+

complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

+
+ +
+
+
+ sriov-automation: + boolean + + + +
+
+
+ +
+
+
+ cloud-extra-info: + string + + +
+
+

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

+
+ +
+
+
+ cloud-epa-caps: + string + + +
+
+

MultiVIM will discover and expose EPA capabilities.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ volume-groups: + object[] + + +
+
+ +
+ +
+ volume-group + + + +
+ +
+
+
+
+ tenants: + object[] + + +
+
+ +
+ +
+ tenant + + + +
+ +
+
+
+
+ flavors: + object[] + + +
+
+ +
+ +
+ flavor + + + +
+ +
+
+
+
+ group-assignments: + object[] + + +
+
+ +
+ +
+ group-assignment + + + +
+ +
+
+
+
+ snapshots: + object[] + + +
+
+ +
+ +
+ snapshot + + + +
+ +
+
+
+
+ images: + object[] + + +
+
+ +
+ +
+ image + + + +
+ +
+
+
+
+ dvs-switches: + object[] + + +
+
+ +
+ +
+ dvs-switch + + + +
+ +
+
+
+
+ oam-networks: + object[] + + +
+
+ +
+ +
+ oam-network + + + +
+ +
+
+
+
+ availability-zones: + object[] + + +
+
+ +
+ +
+ availability-zone + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ vip-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ vip-ipv4-address-list + + + +
+ +
+
+
+
+ vip-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ vip-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-regions: + object + + + +

+
+
+ +
+
+
+ cloud-region: + object[] + + +
+
+ +
+ +
+ cloud-region + + + +
+ +
+
+
+
+
+
+
+
+
+

complex: + object + + + +

+
+
+
+

Collection of physical locations that can house cloud-regions.

+ +
    +
  • TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
  • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
  • +
  • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
  • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
  • +
  • COMPLEX is DELETED when these are DELETED CTAG-POOL
+ +
+ +
+
+
+ physical-location-id: + string + + + +
+
+

Unique identifier for physical location, e.g., CLLI

+
+ +
+
+
+ data-center-code: + string + + +
+
+

Data center code which can be an alternate way to identify a complex

+
+ +
+
+
+ complex-name: + string + + +
+
+

Gamma complex name for LCP instance.

+
+ +
+
+
+ identity-url: + string + + +
+
+

URL of the keystone identity service

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ physical-location-type: + string + + + +
+
+

Type, e.g., central office, data center.

+
+ +
+
+
+ street1: + string + + + +
+
+
+ +
+
+
+ street2: + string + + +
+
+
+ +
+
+
+ city: + string + + + +
+
+
+ +
+
+
+ state: + string + + +
+
+
+ +
+
+
+ postal-code: + string + + + +
+
+
+ +
+
+
+ country: + string + + + +
+
+
+ +
+
+
+ region: + string + + + +
+
+
+ +
+
+
+ latitude: + string + + +
+
+
+ +
+
+
+ longitude: + string + + +
+
+
+ +
+
+
+ elevation: + string + + +
+
+
+ +
+
+
+ lata: + string + + +
+
+
+ +
+
+
+ ctag-pools: + object[] + + +
+
+ +
+ +
+ ctag-pool + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

complexes: + object + + + +

+
+
+
+

Collection of physical locations that can house cloud-regions.

+ +
+ +
+
+
+ complex: + object[] + + +
+
+ +
+ +
+ complex + + + +
+ +
+
+
+
+
+
+
+
+
+

configuration: + object + + + +

+
+
+
+

Port Mirror Configuration.

+ +
    +
  • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
  • +
  • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
  • +
  • TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
  • +
  • TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
  • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
  • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
  • +
  • FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
  • +
  • FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
  • +
  • FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
  • +
  • CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
  • +
  • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ +
+ +
+
+
+ configuration-id: + string + + + +
+
+

UUID assigned to configuration.

+
+ +
+
+
+ management-option: + string + + +
+
+

Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

+
+ +
+
+
+ configuration-name: + string + + +
+
+

Name of the configuration.

+
+ +
+
+
+ configuration-type: + string + + + +
+
+

port-mirroring-configuration.

+
+ +
+
+
+ configuration-sub-type: + string + + + +
+
+

vprobe, pprobe.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ orchestration-status: + string + + + +
+
+

Orchestration status of the configuration.

+
+ +
+
+
+ operational-status: + string + + + +
+
+

Indicator for whether the resource is considered operational.

+
+ +
+
+
+ configuration-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details from SDN-GC.

+
+ +
+
+
+ model-customization-id: + string + + + +
+
+

id of the configuration used to customize the resource

+
+ +
+
+
+ tunnel-bandwidth: + string + + +
+
+

DHV Site Effective Bandwidth

+
+ +
+
+
+ vendor-allowed-max-bandwidth: + string + + +
+
+

Velocloud Nominal Throughput - VNT

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+ forwarder-evcs: + object[] + + +
+
+ +
+ +
+ forwarder-evc + + + +
+ +
+
+
+
+ evcs: + object[] + + +
+
+ +
+ +
+ evc + + + +
+ +
+
+
+
+
+
+
+
+
+

configurations: + object + + + +

+
+
+
+

Collection of configurations

+ +
+ +
+
+
+ configuration: + object[] + + +
+
+ +
+ +
+ configuration + + + +
+ +
+
+
+
+
+
+
+
+
+

connector: + object + + + +

+
+
+
+

Collection of resource instances used to connect a variety of disparate inventory widgets

+ +
    +
  • TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
  • +
  • CONNECTOR is DELETED when these are DELETED METADATUM
+ +
+ +
+
+
+ resource-instance-id: + string + + + +
+
+

Unique id of resource instance.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

connectors: + object + + + +

+
+
+
+

Collection of resource instances used to connect a variety of disparate inventory widgets

+ +
+ +
+
+
+ connector: + object[] + + +
+
+ +
+ +
+ connector + + + +
+ +
+
+
+
+
+
+
+
+
+

constrained-element-set: + object + + + +

+
+
+
+

This is how we would capture constraints defining allowed sets of elements.

+ +
    +
  • TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
  • +
  • TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
  • +
  • FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
  • +
  • CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
+ +
+ +
+
+
+ constrained-element-set-uuid: + string + + + +
+
+
+ +
+
+
+ constraint-type: + string + + + +
+
+
+ +
+
+
+ check-type: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ element-choice-sets: + object[] + + +
+
+ +
+ +
+ element-choice-set + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

constrained-element-sets: + object + + + +

+
+
+ +
+
+
+ constrained-element-set: + object[] + + +
+
+ +
+ +
+ constrained-element-set + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-assignment: + object + + + +

+
+
+
+ +
    +
  • TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ +
+ +
+
+
+ vlan-id-inner: + integer + + + +
+
+

id.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-assignments: + object + + + +

+
+
+ +
+
+
+ ctag-assignment: + object[] + + +
+
+ +
+ +
+ ctag-assignment + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-pool: + object + + + +

+
+
+
+

A collection of C tags (vlan tags) grouped for a specific purpose.

+ +
    +
  • TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
  • +
  • TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
  • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ +
+ +
+
+
+ target-pe: + string + + + +
+
+

The Target provider edge router

+
+ +
+
+
+ availability-zone-name: + string + + + +
+
+

Name of the availability zone

+
+ +
+
+
+ ctag-pool-purpose: + string + + + +
+
+

Describes what the intended purpose of this pool is.

+
+ +
+
+
+ ctag-values: + string + + +
+
+

Comma separated list of ctags

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-pools: + object + + + +

+
+
+ +
+
+
+ ctag-pool: + object[] + + +
+
+ +
+ +
+ ctag-pool + + + +
+ +
+
+
+
+
+
+
+
+
+

customer: + object + + + +

+
+
+
+

customer identifiers to provide linkage back to BSS information.

+ +
    +
  • FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
  • +
  • CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
+ +
+ +
+
+
+ global-customer-id: + string + + + +
+
+

Global customer id used across ECOMP to uniquely identify customer.

+
+ +
+
+
+ subscriber-name: + string + + + +
+
+

Subscriber name, an alternate way to retrieve a customer.

+
+ +
+
+
+ subscriber-type: + string + + + +
+
+

Subscriber type, a way to provide VID with only the INFRA customers.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ service-subscriptions: + object[] + + +
+
+ +
+ +
+ service-subscription + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

customers: + object + + + +

+
+
+
+

Collection of customer identifiers to provide linkage back to BSS information.

+ +
+ +
+
+
+ customer: + object[] + + +
+
+ +
+ +
+ customer + + + +
+ +
+
+
+
+
+
+
+
+
+

cvlan-tag-entry: + object + + + +

+
+
+ +
+
+
+ cvlan-tag: + integer + + + +
+
+

See mis-na-virtualization-platform.yang

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

cvlan-tags: + object + + + +

+
+
+ +
+
+
+ cvlan-tag-entry: + object[] + + +
+
+ +
+ +
+ cvlan-tag-entry + + + +
+ +
+
+
+
+
+
+
+
+
+

dvs-switch: + object + + + +

+
+
+
+

Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.

+ +
    +
  • TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ +
+ +
+
+
+ switch-name: + string + + + +
+
+

DVS switch name

+
+ +
+
+
+ vcenter-url: + string + + + +
+
+

URL used to reach the vcenter

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

dvs-switches: + object + + + +

+
+
+
+

Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

+ +
+ +
+
+
+ dvs-switch: + object[] + + +
+
+ +
+ +
+ dvs-switch + + + +
+ +
+
+
+
+
+
+
+
+
+

edge-prop-names: + object + + + +

+
+
+
+

Internal map to define the properties of an edge and interpret the map EdgeRules

+ +
+ +
+
+
+ edgeLabel: + string + + +
+
+
+ +
+
+
+ direction: + string + + +
+
+
+ +
+
+
+ multiplicityRule: + string + + +
+
+
+ +
+
+
+ contains-other-v: + string + + +
+
+
+ +
+
+
+ delete-other-v: + string + + +
+
+
+ +
+
+
+ SVC-INFRA: + string + + +
+
+
+ +
+
+
+ prevent-delete: + string + + +
+
+
+ +
+
+
+ aai-uuid: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

edge-tag-query-request: + object + + + +

+
+
+ +
+
+
+ edge-tag: + string + + +
+
+
+ +
+
+
+ result-detail: + string + + +
+
+
+ +
+
+
+ start-node-type: + string + + +
+
+
+ +
+
+
+ start-node-filter: + object[] + + +
+
+ +
+ +
+ start-node-filter + + + +
+ +
+
+
+
+ include-node-filter: + object[] + + +
+
+ +
+ +
+ include-node-filter + + + +
+ +
+
+
+
+ secondary-filter: + object[] + + +
+
+ +
+ +
+ secondary-filter + + + +
+ +
+
+
+
+
+
+
+
+
+

edge-tag-query-result: + object + + + +

+
+
+ +
+
+
+ tagged-inventory-item-list: + object[] + + +
+
+ +
+ +
+ tagged-inventory-item-list + + + +
+ +
+
+
+
+
+
+
+
+
+

element-choice-set: + object + + + +

+
+
+
+

This is how we would capture constraints defining allowed sets of elements.

+ +
    +
  • TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
  • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
  • +
  • ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
+ +
+ +
+
+
+ element-choice-set-uuid: + string + + + +
+
+
+ +
+
+
+ element-choice-set-name: + string + + + +
+
+
+ +
+
+
+ cardinality: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ model-elements: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

element-choice-sets: + object + + + +

+
+
+ +
+
+
+ element-choice-set: + object[] + + +
+
+ +
+ +
+ element-choice-set + + + +
+ +
+
+
+
+
+
+
+
+
+

entitlement: + object + + + +

+
+
+
+

Metadata for entitlement group.

+ +
    +
  • TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ +
+ +
+
+
+ group-uuid: + string + + + +
+
+

Unique ID for the entitlement group the resource comes from, should be uuid.

+
+ +
+
+
+ resource-uuid: + string + + + +
+
+

Unique ID of an entitlement resource.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

entitlements: + object + + + +

+
+
+
+

Entitlements, keyed by group-uuid and resource-uuid, related to license management

+ +
+ +
+
+
+ entitlement: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-ems: + object + + + +

+
+
+
+

Persist EMS address information used by EMS driver.

+ +
    +
  • TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
  • +
  • ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ +
+ +
+
+
+ ems-id: + string + + + +
+
+

Unique ID of EMS.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ esr-system-info-list: + object + + +
+
+ +
+ +
+ esr-system-info-list + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-ems-list: + object + + + +

+
+
+ +
+
+
+ esr-ems: + object[] + + +
+
+ +
+ +
+ esr-ems + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-system-info: + object + + + +

+
+
+
+

Persist common address information of external systems.

+ +
    +
  • FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
  • +
  • FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
  • +
  • FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
  • +
  • FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
+ +
+ +
+
+
+ esr-system-info-id: + string + + + +
+
+

Unique ID of esr system info.

+
+ +
+
+
+ system-name: + string + + +
+
+

name of external system.

+
+ +
+
+
+ type: + string + + +
+
+

type of external systems.

+
+ +
+
+
+ vendor: + string + + +
+
+

vendor of external systems.

+
+ +
+
+
+ version: + string + + +
+
+

version of external systems.

+
+ +
+
+
+ service-url: + string + + +
+
+

url used to access external systems.

+
+ +
+
+
+ user-name: + string + + + +
+
+

username used to access external systems.

+
+ +
+
+
+ password: + string + + + +
+
+

password used to access external systems.

+
+ +
+
+
+ system-type: + string + + + +
+
+

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+
+ +
+
+
+ protocol: + string + + +
+
+

protocol of third party SDNC, for example netconf/snmp.

+
+ +
+
+
+ ssl-cacert: + string + + +
+
+

ca file content if enabled ssl on auth-url.

+
+ +
+
+
+ ssl-insecure: + boolean + + +
+
+

Whether to verify VIM's certificate.

+
+ +
+
+
+ ip-address: + string + + +
+
+

service IP of ftp server.

+
+ +
+
+
+ port: + string + + +
+
+

service port of ftp server.

+
+ +
+
+
+ cloud-domain: + string + + +
+
+

domain info for authentication.

+
+ +
+
+
+ default-tenant: + string + + +
+
+

default tenant of VIM.

+
+ +
+
+
+ passive: + boolean + + +
+
+

ftp passive mode or not.

+
+ +
+
+
+ remote-path: + string + + +
+
+

resource or performance data file path.

+
+ +
+
+
+ system-status: + string + + +
+
+

the status of external system.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-system-info-list: + object + + + +

+
+
+
+

Collection of persistent block-level external system auth info.

+ +
+ +
+
+
+ esr-system-info: + object[] + + +
+
+ +
+ +
+ esr-system-info + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-thirdparty-sdnc: + object + + + +

+
+
+
+

Persist SDNC address information used by ONAP SDNC.

+ +
    +
  • TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
  • +
  • TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
  • +
  • ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ +
+ +
+
+
+ thirdparty-sdnc-id: + string + + + +
+
+

Unique ID of SDNC.

+
+ +
+
+
+ location: + string + + +
+
+

used for DC type to indicate the location of SDNC, such as Core or Edge.

+
+ +
+
+
+ product-name: + string + + +
+
+

password used to access SDNC server.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ esr-system-info-list: + object + + +
+
+ +
+ +
+ esr-system-info-list + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-thirdparty-sdnc-list: + object + + + +

+
+
+ +
+
+
+ esr-thirdparty-sdnc: + object[] + + +
+
+ +
+ +
+ esr-thirdparty-sdnc + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-vnfm: + object + + + +

+
+
+
+

Persist VNFM address information used by VF-C.

+ +
    +
  • TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
  • +
  • ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ +
+ +
+
+
+ vnfm-id: + string + + + +
+
+

Unique ID of VNFM.

+
+ +
+
+
+ vim-id: + string + + +
+
+

indecate the VIM to deploy VNF.

+
+ +
+
+
+ certificate-url: + string + + +
+
+

certificate url of VNFM.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ esr-system-info-list: + object + + +
+
+ +
+ +
+ esr-system-info-list + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-vnfm-list: + object + + + +

+
+
+ +
+
+
+ esr-vnfm: + object[] + + +
+
+ +
+ +
+ esr-vnfm + + + +
+ +
+
+
+
+
+
+
+
+
+

evc: + object + + + +

+
+
+
+

evc object is an optional child object of the Configuration object.

+ +
    +
  • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ +
+ +
+
+
+ evc-id: + string + + + +
+
+

Unique/key field for the evc object

+
+ +
+
+
+ forwarding-path-topology: + string + + +
+
+

Point-to-Point, Multi-Point

+
+ +
+
+
+ cir-value: + string + + +
+
+

Commited Information Rate

+
+ +
+
+
+ cir-units: + string + + +
+
+

CIR units

+
+ +
+
+
+ connection-diversity-group-id: + string + + +
+
+

Diversity Group ID

+
+ +
+
+
+ service-hours: + string + + +
+
+

formerly Performance Group

+
+ +
+
+
+ esp-evc-circuit-id: + string + + +
+
+

EVC Circuit ID of ESP EVC

+
+ +
+
+
+ esp-evc-cir-value: + string + + +
+
+

Committed Information Rate (For ESP)

+
+ +
+
+
+ esp-evc-cir-units: + string + + +
+
+

CIR units (For ESP)

+
+ +
+
+
+ esp-itu-code: + string + + +
+
+

Identifies ESP

+
+ +
+
+
+ collector-pop-clli: + string + + +
+
+

Collector POP CLLI (from the hostname of the access pnf)

+
+ +
+
+
+ inter-connect-type-ingress: + string + + +
+
+

Interconnect type on ingress side of EVC.

+
+ +
+
+
+ tagmode-access-ingress: + string + + +
+
+

tagode for collector side of EVC

+
+ +
+
+
+ tagmode-access-egress: + string + + +
+
+

tagMode for network side of EVC

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

evcs: + object + + + +

+
+
+ +
+
+
+ evc: + object[] + + +
+
+ +
+ +
+ evc + + + +
+ +
+
+
+
+
+
+
+
+
+

external-system: + object + + + +

+
+
+
+

Namespace for external system.

+ +
+ +
+
+
+ esr-ems-list: + object + + +
+
+ +
+ +
+ esr-ems-list + + + +
+ +
+
+
+
+ esr-vnfm-list: + object + + +
+
+ +
+ +
+ esr-vnfm-list + + + +
+ +
+
+
+
+ esr-thirdparty-sdnc-list: + object + + +
+
+ +
+ +
+ esr-thirdparty-sdnc-list + + + +
+ +
+
+
+
+
+
+
+
+
+

extra-properties: + object + + + +

+
+
+
+

Extra properties for inventory item for response list

+ +
+ +
+
+
+ extra-property: + object[] + + +
+
+ +
+ +
+ extra-property + + + +
+ +
+
+
+
+
+
+
+
+
+

extra-property: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

flavor: + object + + + +

+
+
+
+

Openstack flavor.

+ +
    +
  • TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
  • +
  • FLAVOR cannot be deleted if linked to VSERVER
+ +
+ +
+
+
+ flavor-id: + string + + + +
+
+

Flavor id, expected to be unique across cloud-region.

+
+ +
+
+
+ flavor-name: + string + + + +
+
+

Flavor name

+
+ +
+
+
+ flavor-vcpus: + integer + + +
+
+

Number of CPUs

+
+ +
+
+
+ flavor-ram: + integer + + +
+
+

Amount of memory

+
+ +
+
+
+ flavor-disk: + integer + + +
+
+

Disk space

+
+ +
+
+
+ flavor-ephemeral: + integer + + +
+
+

Amount of ephemeral disk space

+
+ +
+
+
+ flavor-swap: + string + + +
+
+

amount of swap space allocation

+
+ +
+
+
+ flavor-is-public: + boolean + + +
+
+

whether flavor is available to all users or private to the tenant it was created in.

+
+ +
+
+
+ flavor-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ flavor-disabled: + boolean + + +
+
+

Boolean as to whether this flavor is no longer enabled

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

flavors: + object + + + +

+
+
+
+

Collection of openstack flavors.

+ +
+ +
+
+
+ flavor: + object[] + + +
+
+ +
+ +
+ flavor + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarder: + object + + + +

+
+
+
+

Entity describing a sequenced segment of forwarding path

+ +
    +
  • TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
  • +
  • TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
  • +
  • TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
  • +
  • TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
  • +
  • TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
  • +
  • FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ +
+ +
+
+
+ sequence: + integer + + + +
+
+

Unique ID of this segmentation

+
+ +
+
+
+ forwarder-role: + string + + +
+
+

ingress, intermediate, egress

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarder-evc: + object + + + +

+
+
+
+

forwarder object is an optional child object of the Configuration object.

+ +
    +
  • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ +
+ +
+
+
+ forwarder-evc-id: + string + + + +
+
+

Key for forwarder-evc object

+
+ +
+
+
+ circuit-id: + string + + +
+
+

Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

+
+ +
+
+
+ ivlan: + string + + +
+
+

Internal VLAN.

+
+ +
+
+
+ svlan: + string + + +
+
+

SVLAN value for ingress of egress forwarder.

+
+ +
+
+
+ cvlan: + string + + +
+
+

CVLAN value for ingress of egress forwarder.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarder-evcs: + object + + + +

+
+
+ +
+
+
+ forwarder-evc: + object[] + + +
+
+ +
+ +
+ forwarder-evc + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarders: + object + + + +

+
+
+ +
+
+
+ forwarder: + object[] + + +
+
+ +
+ +
+ forwarder + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarding-path: + object + + + +

+
+
+
+

Entity that describes the sequenced forwarding path between interfaces of services or resources

+ +
    +
  • TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
  • +
  • TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
  • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
  • +
  • FORWARDING-PATH is DELETED when these are DELETED FORWARDER
  • +
  • FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ +
+ +
+
+
+ forwarding-path-id: + string + + + +
+
+

Unique ID of this FP

+
+ +
+
+
+ forwarding-path-name: + string + + + +
+
+

Name of the FP

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ selflink: + string + + +
+
+

the self link for this FP

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ forwarders: + object[] + + +
+
+ +
+ +
+ forwarder + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarding-paths: + object + + + +

+
+
+ +
+
+
+ forwarding-path: + object[] + + +
+
+ +
+ +
+ forwarding-path + + + +
+ +
+
+
+
+
+
+
+
+
+

generic-vnf: + object + + + +

+
+
+
+

General purpose VNF

+ +
    +
  • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
  • +
  • TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
  • +
  • TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
  • +
  • TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
  • +
  • TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
  • +
  • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
  • +
  • TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
  • +
  • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
  • +
  • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
  • +
  • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
  • +
  • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
  • +
  • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
  • +
  • TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
  • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
  • +
  • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
  • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
  • +
  • FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
  • +
  • GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
  • +
  • GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ +
+ +
+
+
+ vnf-id: + string + + + +
+
+

Unique id of VNF. This is unique across the graph.

+
+ +
+
+
+ vnf-instance-id: + string + + + +
+
+

vnf instance id.

+
+ +
+
+
+ vnf-name: + string + + + +
+
+

Name of VNF.

+
+ +
+
+
+ vnf-name2: + string + + +
+
+

Alternate name of VNF.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ service-id: + string + + +
+
+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
+ +
+
+
+ regional-resource-zone: + string + + +
+
+

Regional way of organizing pservers, source of truth should define values

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this resource by Service Assurance systems.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

+
+ +
+
+
+ license-key: + string + + +
+
+

OBSOLETE - do not use

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, used by MSO.

+
+ +
+
+
+ vnf-package-name: + string + + + +
+
+
+ +
+
+
+ vnf-discriptor-name: + string + + + +
+
+

vnf discriptor name

+
+ +
+
+
+ job-id: + string + + + +
+
+

job id corresponding to vnf

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ management-option: + string + + +
+
+

identifier of managed by ATT or customer

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.

+
+ +
+
+
+ ipv4-loopback0-address: + string + + +
+
+

v4 Loopback0 address

+
+ +
+
+
+ nm-lan-v6-address: + string + + +
+
+

v6 Loopback address

+
+ +
+
+
+ management-v6-address: + string + + +
+
+

v6 management address

+
+ +
+
+
+ vcpu: + integer + + +
+
+

number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vcpu-units: + string + + +
+
+

units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vmemory: + integer + + +
+
+

number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vmemory-units: + string + + +
+
+

units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vdisk: + integer + + +
+
+

number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE

+
+ +
+
+
+ vdisk-units: + string + + +
+
+

units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ nshd: + integer + + +
+
+

number of associated SHD in vnf.

+
+ +
+
+
+ nvm: + integer + + +
+
+

number of vms in vnf.

+
+ +
+
+
+ nnet: + integer + + +
+
+

number of network in vnf.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ is-closed-loop-disabled: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ summary-status: + string + + +
+
+

details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.

+
+ +
+
+
+ encrypted-access-flag: + boolean + + +
+
+

indicates whether generic-vnf access uses SSH

+
+ +
+
+
+ entitlement-assignment-group-uuid: + string + + +
+
+

UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.

+
+ +
+
+
+ entitlement-resource-uuid: + string + + +
+
+

UUID of the specific entitlement resource. OBSOLETE - See child relationships.

+
+ +
+
+
+ license-assignment-group-uuid: + string + + +
+
+

UUID of the license assignment group. OBSOLETE - See child relationships.

+
+ +
+
+
+ license-key-uuid: + string + + +
+
+

UUID of the actual license resource. OBSOLETE - See child relationships.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
+ +
+
+
+ as-number: + string + + +
+
+

as-number of the VNF

+
+ +
+
+
+ regional-resource-subzone: + string + + +
+
+

represents sub zone of the rr plane

+
+ +
+
+
+ nf-type: + string + + +
+
+

Generic description of the type of NF

+
+ +
+
+
+ nf-function: + string + + +
+
+

English description of Network function that the specific VNF deployment is providing

+
+ +
+
+
+ nf-role: + string + + +
+
+

role in the network that this model will be providing

+
+ +
+
+
+ nf-naming-code: + string + + +
+
+

string assigned to this model used for naming purposes

+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ ipv4-oam-gateway-address: + string + + +
+
+

Gateway address

+
+ +
+
+
+ ipv4-oam-gateway-address-prefix-length: + integer + + +
+
+

Prefix length for oam-address

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Temporary location for S-TAG to get to VCE

+
+ +
+
+
+ nm-profile-name: + string + + +
+
+

Network Management profile of this VNF

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+ vf-modules: + object[] + + +
+
+ +
+ +
+ vf-module + + + +
+ +
+
+
+
+ licenses: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+ entitlements: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+
+
+
+
+
+

generic-vnfs: + object + + + +

+
+
+
+

Collection of VNFs

+ +
+ +
+
+
+ generic-vnf: + object[] + + +
+
+ +
+ +
+ generic-vnf + + + +
+ +
+
+
+
+
+
+
+
+
+

group-assignment: + object + + + +

+
+
+
+

Openstack group-assignment used to store exclusivity groups (EG).

+ +
    +
  • TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
  • +
  • FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ +
+ +
+
+
+ group-id: + string + + + +
+
+

Group id, expected to be unique across cloud-region.

+
+ +
+
+
+ group-type: + string + + + +
+
+

Group type - the type of group this instance refers to

+
+ +
+
+
+ group-name: + string + + + +
+
+

Group name - name assigned to the group

+
+ +
+
+
+ group-description: + string + + +
+
+

Group description - description of the group

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

group-assignments: + object + + + +

+
+
+
+

Collection of openstack group assignments

+ +
+ +
+
+
+ group-assignment: + object[] + + +
+
+ +
+ +
+ group-assignment + + + +
+ +
+
+
+
+
+
+
+
+
+

host-route: + object + + + +

+
+
+
+ +
    +
  • TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ +
+ +
+
+
+ host-route-id: + string + + + +
+
+

host-route id

+
+ +
+
+
+ route-prefix: + string + + + +
+
+

subnet prefix

+
+ +
+
+
+ next-hop: + string + + + +
+
+

Could be ip-address, hostname, or service-instance

+
+ +
+
+
+ next-hop-type: + string + + +
+
+

Should be ip-address, hostname, or service-instance to match next-hop

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

host-routes: + object + + + +

+
+
+ +
+
+
+ host-route: + object[] + + +
+
+ +
+ +
+ host-route + + + +
+ +
+
+
+
+
+
+
+
+
+

image: + object + + + +

+
+
+
+

Openstack image.

+ +
    +
  • TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
  • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
  • +
  • IMAGE cannot be deleted if linked to VSERVER
  • +
  • IMAGE is DELETED when these are DELETED METADATUM
+ +
+ +
+
+
+ image-id: + string + + + +
+
+

Image id, expected to be unique across cloud region

+
+ +
+
+
+ image-name: + string + + + +
+
+

Image name

+
+ +
+
+
+ image-architecture: + string + + +
+
+

Operating system architecture.

+
+ +
+
+
+ image-os-distro: + string + + + +
+
+

The common name of the operating system distribution in lowercase

+
+ +
+
+
+ image-os-version: + string + + + +
+
+

The operating system version as specified by the distributor.

+
+ +
+
+
+ application: + string + + +
+
+

The application that the image instantiates.

+
+ +
+
+
+ application-vendor: + string + + +
+
+

The vendor of the application.

+
+ +
+
+
+ application-version: + string + + +
+
+

The version of the application.

+
+ +
+
+
+ image-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

images: + object + + + +

+
+
+
+

Collectio of Openstack images.

+ +
+ +
+
+
+ image: + object[] + + +
+
+ +
+ +
+ image + + + +
+ +
+
+
+
+
+
+
+
+
+

include-node-filter: + object + + + +

+
+
+ +
+
+
+ include-node-type: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

instance-filter: + object + + + +

+
+
+
+

InstanceFilter for performing a named-query or model query

+ +
+ +
+
+
+
+
+
+
+
+

instance-filters: + object + + + +

+
+
+
+

InstanceFilters for performing a named-query or model query

+ +
+ +
+
+
+ instance-filter: + object[] + + +
+
+ +
+ +
+ instance-filter + + + +
+ +
+
+
+
+
+
+
+
+
+

instance-group: + object + + + +

+
+
+
+

General mechanism for grouping instances

+ +
    +
  • TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
  • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ +
+ +
+
+
+ instance-group-role: + string + + + +
+
+

role of the instance group.

+
+ +
+
+
+ model-invariant-id: + string + + + +
+
+

ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + + +
+
+

ASDC model version uid for this resource model.

+
+ +
+
+
+ id: + string + + + +
+
+

Instance Group ID, UUID assigned to this instance.

+
+ +
+
+
+ description: + string + + + +
+
+

Descriptive text to help identify the usage of this instance-group

+
+ +
+
+
+ type: + string + + + +
+
+

Only valid value today is lower case ha for high availability

+
+ +
+
+
+ sub-type: + string + + +
+
+

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

instance-groups: + object + + + +

+
+
+
+

Collection of openstack route table references

+ +
+ +
+
+
+ instance-group: + object[] + + +
+
+ +
+ +
+ instance-group + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory: + object + + + +

+
+
+ +
+
+
+ search: + object + + +
+
+ +
+ +
+ search + + + +
+ +
+
+
+
+ actions: + object + + +
+
+ +
+ +
+ actions + + + +
+ +
+
+
+
+ cloud-infrastructure: + object + + +
+
+ +
+ +
+ cloud-infrastructure + + + +
+ +
+
+
+
+ external-system: + object + + +
+
+ +
+ +
+ external-system + + + +
+ +
+
+
+
+ business: + object + + +
+
+ +
+ +
+ business + + + +
+ +
+
+
+
+ service-design-and-creation: + object + + +
+
+ +
+ +
+ service-design-and-creation + + + +
+ +
+
+
+
+ network: + object + + +
+
+ +
+ +
+ network + + + +
+ +
+
+
+
+ aai-internal: + object + + +
+
+ +
+ +
+ aai-internal + + + +
+ +
+
+
+
+ nodes: + object[] + + +
+
+ +
+ +
+ aai-internal + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory-item: + object + + + +

+
+
+ +
+
+
+ inventory-item-type: + string + + +
+
+
+ +
+
+
+ inventory-item-link: + string + + +
+
+
+ +
+
+
+ inventory-item-data: + object[] + + +
+
+ +
+ +
+ inventory-item-data + + + +
+ +
+
+
+
+ tagged-inventory-item-list: + object[] + + +
+
+ +
+ +
+ tagged-inventory-item-list + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory-item-data: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

inventory-response-item: + object + + + +

+
+
+
+

Inventory item for response list

+ +
+ +
+
+
+ model-name: + string + + +
+
+
+ +
+
+
+ extra-properties: + object + + +
+
+ +
+ +
+ extra-properties + + + +
+ +
+
+
+
+ inventory-response-items: + object + + +
+
+ +
+ +
+ inventory-response-items + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory-response-items: + object + + + +

+
+
+
+

Container for inventory items in response list

+ +
+ +
+
+
+ inventory-response-item: + object[] + + +
+
+ +
+ +
+ inventory-response-item + + + +
+ +
+
+
+
+
+
+
+
+
+

ipsec-configuration: + object + + + +

+
+
+
+

IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C

+ +
    +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
  • +
  • FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
  • +
  • IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
+ +
+ +
+
+
+ ipsec-configuration-id: + string + + + +
+
+

UUID of this configuration

+
+ +
+
+
+ requested-vig-address-type: + string + + +
+
+

Indicate the type of VIG server like AVPN, INTERNET, BOTH

+
+ +
+
+
+ requested-encryption-strength: + string + + +
+
+

Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc

+
+ +
+
+
+ requested-dmz-type: + string + + +
+
+

ATT can offer a shared DMZ or a DMZ specific to a customer

+
+ +
+
+
+ shared-dmz-network-address: + string + + +
+
+

Network address of shared DMZ

+
+ +
+
+
+ requested-customer-name: + string + + +
+
+

If the DMZ is a custom DMZ, this field will indicate the customer information

+
+ +
+
+
+ ike-version: + string + + +
+
+

can be 1 or 2

+
+ +
+
+
+ ikev1-authentication: + string + + +
+
+

Contains values like md5, sha1, sha256, sha384

+
+ +
+
+
+ ikev1-encryption: + string + + +
+
+

Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc

+
+ +
+
+
+ ikev1-dh-group: + string + + +
+
+

Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14

+
+ +
+
+
+ ikev1-am-group-id: + string + + +
+
+

Group name defined in VIG for clients using aggressive mode

+
+ +
+
+
+ ikev1-am-password: + string + + +
+
+

pre-shared key for the above group name

+
+ +
+
+
+ ikev1-sa-lifetime: + string + + +
+
+

Lifetime for IKEv1 SA

+
+ +
+
+
+ ipsec-authentication: + string + + +
+
+

md5, sha1, sha256, sha384

+
+ +
+
+
+ ipsec-encryption: + string + + +
+
+

3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc

+
+ +
+
+
+ ipsec-sa-lifetime: + string + + +
+
+

Life time for IPSec SA

+
+ +
+
+
+ ipsec-pfs: + string + + +
+
+

enable PFS or not

+
+ +
+
+
+ xauth-userid: + string + + +
+
+

user ID for xAuth, sm-user,ucpeHostName,nmteHostName

+
+ +
+
+
+ xauth-user-password: + string + + +
+
+

Encrypted using the Juniper $9$ algorithm

+
+ +
+
+
+ dpd-interval: + string + + +
+
+

The time between DPD probe

+
+ +
+
+
+ dpd-frequency: + string + + +
+
+

Maximum number of DPD before claiming the tunnel is down

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ vig-servers: + object[] + + +
+
+ +
+ +
+ vig-server + + + +
+ +
+
+
+
+
+
+
+
+
+

ipsec-configurations: + object + + + +

+
+
+ +
+
+
+ ipsec-configuration: + object[] + + +
+
+ +
+ +
+ ipsec-configuration + + + +
+ +
+
+
+
+
+
+
+
+
+

key-data: + object + + + +

+
+
+ +
+
+
+ key-name: + string + + +
+
+
+ +
+
+
+ key-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

l-interface: + object + + + +

+
+
+
+

Logical interfaces, e.g., a vnic.

+ +
    +
  • TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
  • +
  • TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
  • +
  • TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
  • +
  • TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
  • +
  • TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
  • +
  • TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
  • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
  • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
  • +
  • FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
  • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
  • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
  • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
  • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name given to the interface

+
+ +
+
+
+ interface-role: + string + + +
+
+

E.g., CUSTOMER, UPLINK, etc.

+
+ +
+
+
+ v6-wan-link-ip: + string + + +
+
+

Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ interface-id: + string + + +
+
+

ID of interface

+
+ +
+
+
+ macaddr: + string + + +
+
+

MAC address for the interface

+
+ +
+
+
+ network-name: + string + + +
+
+

Name of the network

+
+ +
+
+
+ management-option: + string + + +
+
+

Whether A&AI should be managing this interface of not. Could have value like CUSTOMER

+
+ +
+
+
+ interface-description: + string + + +
+
+

Human friendly text regarding this interface.

+
+ +
+
+
+ is-port-mirrored: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].

+
+ +
+
+
+ is-ip-unnumbered: + boolean + + + +
+
+
+ +
+
+
+ allowed-address-pairs: + string + + +
+
+

Freeform field for storing an ip address, list of ip addresses or a subnet block.

+
+ +
+
+
+ vlans: + object[] + + +
+
+ +
+ +
+ vlan + + + +
+ +
+
+
+
+ sriov-vfs: + object[] + + +
+
+ +
+ +
+ sriov-vf + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l3-interface-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv4-address-list + + + +
+ +
+
+
+
+ l3-interface-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

l-interfaces: + object + + + +

+
+
+
+

Collection of logical interfaces.

+ +
+ +
+
+
+ l-interface: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-interface-ipv4-address-list: + object + + + +

+
+
+
+

IPv4 Address Range

+ +
    +
  • TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
  • +
  • TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
  • +
  • TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
  • +
  • TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
  • +
  • TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
  • +
  • TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ +
+ +
+
+
+ l3-interface-ipv4-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ l3-interface-ipv4-prefix-length: + integer + + +
+
+

Prefix length, 32 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-interface-ipv6-address-list: + object + + + +

+
+
+
+

IPv6 Address Range

+ +
    +
  • TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
  • +
  • TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
  • +
  • TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
  • +
  • TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
  • +
  • TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
  • +
  • TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ +
+ +
+
+
+ l3-interface-ipv6-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ l3-interface-ipv6-prefix-length: + integer + + +
+
+

Prefix length, 128 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-network: + object + + + +

+
+
+
+

Generic network definition

+ +
    +
  • TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
  • +
  • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
  • +
  • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
  • +
  • TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
  • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
  • +
  • FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
  • +
  • FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
  • +
  • FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
  • +
  • FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
  • +
  • L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ +
+ +
+
+
+ network-id: + string + + + +
+
+

Network ID, should be uuid. Unique across A&AI.

+
+ +
+
+
+ network-name: + string + + + +
+
+

Name of the network, governed by some naming convention..

+
+ +
+
+
+ network-type: + string + + +
+
+

Type of the network - who defines these values?

+
+ +
+
+
+ network-role: + string + + +
+
+

Role the network plans - who defines these values?

+
+ +
+
+
+ network-technology: + string + + +
+
+

Network technology - who defines these values?

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of this Interface

+
+ +
+
+
+ is-bound-to-vpn: + boolean + + + +
+
+
+ +
+
+
+ service-id: + string + + +
+
+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
+ +
+
+
+ network-role-instance: + integer + + +
+
+

network role instance

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ contrail-network-fqdn: + string + + +
+
+

Contrail FQDN for the network

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
+ +
+
+
+ physical-network-name: + string + + +
+
+

Name associated with the physical network.

+
+ +
+
+
+ is-provider-network: + boolean + + + +
+
+
+ +
+
+
+ is-shared-network: + boolean + + + +
+
+
+ +
+
+
+ is-external-network: + boolean + + + +
+
+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational.

+
+ +
+
+
+ subnets: + object[] + + +
+
+ +
+ +
+ subnet + + + +
+ +
+
+
+
+ ctag-assignments: + object[] + + +
+
+ +
+ +
+ ctag-assignment + + + +
+ +
+
+
+
+ segmentation-assignments: + object[] + + +
+
+ +
+ +
+ segmentation-assignment + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-networks: + object + + + +

+
+
+ +
+
+
+ l3-network: + object[] + + +
+
+ +
+ +
+ l3-network + + + +
+ +
+
+
+
+
+
+
+
+
+

lag-interface: + object + + + +

+
+
+
+

Link aggregate interface

+ +
    +
  • TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
  • +
  • TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
  • +
  • TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
  • +
  • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
  • +
  • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
  • +
  • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
  • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
  • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
  • +
  • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
  • +
  • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name that identifies the link aggregate interface

+
+ +
+
+
+ interface-description: + string + + +
+
+

Human friendly text regarding this interface.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ speed-value: + string + + +
+
+

Captures the numeric part of the speed

+
+ +
+
+
+ speed-units: + string + + +
+
+

Captures the units corresponding to the speed

+
+ +
+
+
+ interface-id: + string + + +
+
+

ID of interface

+
+ +
+
+
+ interface-role: + string + + +
+
+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this resource by Service Assurance systems.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

lag-interfaces: + object + + + +

+
+
+
+

Collection of link aggregate interfaces.

+ +
+ +
+
+
+ lag-interface: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

license: + object + + + +

+
+
+
+

Metadata for license group.

+ +
    +
  • TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ +
+ +
+
+
+ group-uuid: + string + + + +
+
+

Unique ID for the license group the resource belongs to, should be uuid.

+
+ +
+
+
+ resource-uuid: + string + + + +
+
+

Unique ID of a license resource.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

licenses: + object + + + +

+
+
+
+

Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

+ +
+ +
+
+
+ license: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+
+
+
+
+
+

line-of-business: + object + + + +

+
+
+
+

describes a line-of-business

+ +
    +
  • TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ +
+ +
+
+
+ line-of-business-name: + string + + + +
+
+

Name of the line-of-business (product)

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

lines-of-business: + object + + + +

+
+
+
+

Collection of lines-of-business

+ +
+ +
+
+
+ line-of-business: + object[] + + +
+
+ +
+ +
+ line-of-business + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

metadata: + object + + + +

+
+
+
+

Collection of metadatum (key/value pairs)

+ +
+ +
+
+
+ metadatum: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

metadatum: + object + + + +

+
+
+
+

Key/value pairs

+ +
    +
  • TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
  • +
  • TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
  • +
  • TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
  • +
  • TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
  • +
  • TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ +
+ +
+
+
+ metaname: + string + + + +
+
+
+ +
+
+
+ metaval: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+
+
+
+
+
+

model: + object + + + +

+
+
+
+

Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

+ +
    +
  • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
  • +
  • FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
  • +
  • FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
  • +
  • FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
  • +
  • FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
  • +
  • MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
  • +
  • MODEL is DELETED when these are DELETED MODEL-VER
+ +
+ +
+
+
+ model-invariant-id: + string + + + +
+
+

Unique identifier corresponding to the main definition of a model in ASDC

+
+ +
+
+
+ model-type: + string + + + +
+
+

Type of the model, e.g., service, resource, widget, etc.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-vers: + object[] + + +
+
+ +
+ +
+ model-ver + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+ +
+
+

model-constraint: + object + + + +

+
+
+
+

This is how we would capture constraints defining allowed sets of elements.

+ +
    +
  • TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
  • +
  • FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
  • +
  • MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
+ +
+ +
+
+
+ model-constraint-uuid: + string + + + +
+
+
+ +
+
+
+ constrained-element-set-uuid-to-replace: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ constrained-element-sets: + object[] + + +
+
+ +
+ +
+ constrained-element-set + + + +
+ +
+
+
+
+
+
+
+
+
+

model-constraints: + object + + + +

+
+
+ +
+
+
+ model-constraint: + object[] + + +
+
+ +
+ +
+ model-constraint + + + +
+ +
+
+
+
+
+
+
+
+
+

model-element: + object + + + +

+
+
+
+

Defines how other models combine to make up a higher-level model.

+ +
    +
  • TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
  • +
  • TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
  • +
  • TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
  • +
  • TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
  • +
  • FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
  • +
  • FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
  • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
  • +
  • MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
+ +
+ +
+
+
+ model-element-uuid: + string + + + +
+
+
+ +
+
+
+ new-data-del-flag: + string + + + +
+
+

Indicates whether this element was created as part of instantiation from this model

+
+ +
+
+
+ cardinality: + string + + + +
+
+

How many of this type of element are required/allowed

+
+ +
+
+
+ linkage-points: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-elements: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+ model-constraints: + object[] + + +
+
+ +
+ +
+ model-constraint + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

model-elements: + object + + + +

+
+
+ +
+
+
+ model-element: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+
+
+
+
+
+

model-ver: + object + + + +

+
+
+
+

Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

+ +
    +
  • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
  • +
  • FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
  • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
  • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
  • +
  • MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ +
+ +
+
+
+ model-version-id: + string + + + +
+
+

Unique identifier corresponding to one version of a model in ASDC

+
+ +
+
+
+ model-name: + string + + + +
+
+

Name of the model, which can change from version to version.

+
+ +
+
+
+ model-version: + string + + + +
+
+

Version

+
+ +
+
+
+ distribution-status: + string + + +
+
+

Distribution Status

+
+ +
+
+
+ model-description: + string + + +
+
+

Description

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-elements: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

model-vers: + object + + + +

+
+
+ +
+
+
+ model-ver: + object[] + + +
+
+ +
+ +
+ model-ver + + + +
+ +
+
+
+
+
+
+
+
+
+

models: + object + + + +

+
+
+
+

Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models

+ +
+ +
+
+
+ model: + object[] + + +
+
+ +
+ +
+ model + + + +
+ +
+
+
+
+
+
+
+
+
+

multicast-configuration: + object + + + +

+
+
+
+ +
    +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ +
+ +
+
+
+ multicast-configuration-id: + string + + + +
+
+

Unique id of multicast configuration.

+
+ +
+
+
+ multicast-protocol: + string + + + +
+
+

protocol of multicast configuration

+
+ +
+
+
+ rp-type: + string + + + +
+
+

rp type of multicast configuration

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

multicast-configurations: + object + + + +

+
+
+
+

multicast configuration of generic-vnf ip-address

+ +
+ +
+
+
+ multicast-configuration: + object[] + + +
+
+ +
+ +
+ multicast-configuration + + + +
+ +
+
+
+
+
+
+
+
+
+

named-queries: + object + + + +

+
+
+ +
+
+
+ named-query: + object[] + + +
+
+ +
+ +
+ named-query + + + +
+ +
+
+
+
+
+
+
+
+
+

named-query: + object + + + +

+
+
+
+

TBD

+ +
    +
  • TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
  • +
  • TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
  • +
  • FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
  • +
  • NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
+ +
+ +
+
+
+ named-query-uuid: + string + + + +
+
+
+ +
+
+
+ named-query-name: + string + + + +
+
+
+ +
+
+
+ named-query-version: + string + + + +
+
+
+ +
+
+
+ required-input-param: + string + + +
+
+
+ +
+
+
+ description: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ named-query-elements: + object[] + + +
+
+ +
+ +
+ named-query-element + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

named-query-element: + object + + + +

+
+
+
+

TBD

+ +
    +
  • TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
  • +
  • TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
  • +
  • TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
  • +
  • FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
  • +
  • FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
  • +
  • FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
  • +
  • NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
+ +
+ +
+
+
+ named-query-element-uuid: + string + + + +
+
+
+ +
+
+
+ property-collect-list: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ property-limit-desc: + string + + +
+
+
+ +
+
+
+ do-not-output: + string + + +
+
+
+ +
+
+
+ named-query-elements: + object[] + + +
+
+ +
+ +
+ named-query-element + + + +
+ +
+
+
+
+ related-lookups: + object[] + + +
+
+ +
+ +
+ related-lookup + + + +
+ +
+
+
+
+ property-constraints: + object[] + + +
+
+ +
+ +
+ property-constraint + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

named-query-elements: + object + + + +

+
+
+ +
+
+
+ named-query-element: + object[] + + +
+
+ +
+ +
+ named-query-element + + + +
+ +
+
+
+
+
+
+
+
+
+

network: + object + + + +

+
+
+
+

Namespace for network inventory resources.

+ +
+ +
+
+
+ logical-links: + object[] + + +
+
+ +
+ +
+ logical-link + + + +
+ +
+
+
+
+ site-pair-sets: + object[] + + +
+
+ +
+ +
+ site-pair-set + + + +
+ +
+
+
+
+ vpn-bindings: + object[] + + +
+
+ +
+ +
+ vpn-binding + + + +
+ +
+
+
+
+ vpls-pes: + object[] + + +
+
+ +
+ +
+ vpls-pe + + + +
+ +
+
+
+
+ multicast-configurations: + object[] + + +
+
+ +
+ +
+ multicast-configuration + + + +
+ +
+
+
+
+ vces: + object[] + + +
+
+ +
+ +
+ vce + + + +
+ +
+
+
+
+ vnfcs: + object[] + + +
+
+ +
+ +
+ vnfc + + + +
+ +
+
+
+
+ l3-networks: + object[] + + +
+
+ +
+ +
+ l3-network + + + +
+ +
+
+
+
+ network-policies: + object[] + + +
+
+ +
+ +
+ network-policy + + + +
+ +
+
+
+
+ generic-vnfs: + object[] + + +
+
+ +
+ +
+ generic-vnf + + + +
+ +
+
+
+
+ lag-links: + object[] + + +
+
+ +
+ +
+ lag-link + + + +
+ +
+
+
+
+ newvces: + object[] + + +
+
+ +
+ +
+ newvce + + + +
+ +
+
+
+
+ pnfs: + object[] + + +
+
+ +
+ +
+ pnf + + + +
+ +
+
+
+
+ physical-links: + object[] + + +
+
+ +
+ +
+ physical-link + + + +
+ +
+
+
+
+ ipsec-configurations: + object[] + + +
+
+ +
+ +
+ ipsec-configuration + + + +
+ +
+
+
+
+ route-table-references: + object[] + + +
+
+ +
+ +
+ route-table-reference + + + +
+ +
+
+
+
+ instance-groups: + object[] + + +
+
+ +
+ +
+ instance-group + + + +
+ +
+
+
+
+ zones: + object[] + + +
+
+ +
+ +
+ zone + + + +
+ +
+
+
+
+ configurations: + object[] + + +
+
+ +
+ +
+ configuration + + + +
+ +
+
+
+
+ forwarding-paths: + object[] + + +
+
+ +
+ +
+ forwarding-path + + + +
+ +
+
+
+
+
+
+
+
+
+

network-policies: + object + + + +

+
+
+ +
+
+
+ network-policy: + object[] + + +
+
+ +
+ +
+ network-policy + + + +
+ +
+
+
+
+
+
+
+
+
+

network-policy: + object + + + +

+
+
+
+ +
    +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
  • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ +
+ +
+
+
+ network-policy-id: + string + + + +
+
+

UUID representing unique key to this instance

+
+ +
+
+
+ network-policy-fqdn: + string + + +
+
+

Contrail FQDN for the policy

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

ID for the openStack Heat instance

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

network-profile: + object + + + +

+
+
+
+

Network profile populated by SDN-GP for SNMP

+ +
    +
  • TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ +
+ +
+
+
+ nm-profile-name: + string + + + +
+
+

Unique name of network profile.

+
+ +
+
+
+ community-string: + string + + +
+
+

Encrypted SNMP community string

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

network-profiles: + object + + + +

+
+
+
+

Collection of network profiles

+ +
+ +
+
+
+ network-profile: + object[] + + +
+
+ +
+ +
+ network-profile + + + +
+ +
+
+
+
+
+
+
+
+
+

newvce: + object + + + +

+
+
+
+

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

+ +
    +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
  • +
  • NEWVCE is DELETED when these are DELETED L-INTERFACE
+ +
+ +
+
+
+ vnf-id2: + string + + + +
+
+

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
+ +
+
+
+ vnf-name: + string + + + +
+
+

Name of VNF.

+
+ +
+
+
+ vnf-name2: + string + + +
+
+

Alternate name of VNF.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational

+
+ +
+
+
+ license-key: + string + + +
+
+

OBSOLETE - do not use

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ ipv4-loopback0-address: + string + + +
+
+

v4 Loopback0 address

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO.

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

newvces: + object + + + +

+
+
+
+

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

+ +
+ +
+
+
+ newvce: + object[] + + +
+
+ +
+ +
+ newvce + + + +
+ +
+
+
+
+
+
+
+
+
+

notification-event: + object + + + +

+
+
+ +
+
+
+ cambria.partition: + string + + +
+
+
+ +
+
+
+ notification-event-header: + object + + +
+
+ +
+ +
+ notification-event-header + + + +
+ +
+
+
+
+
+
+
+
+
+

notification-event-header: + object + + + +

+
+
+ +
+
+
+ id: + string + + +
+
+
+ +
+
+
+ timestamp: + string + + +
+
+
+ +
+
+
+ source-name: + string + + +
+
+
+ +
+
+
+ domain: + string + + +
+
+
+ +
+
+
+ sequence-number: + string + + +
+
+
+ +
+
+
+ severity: + string + + +
+
+
+ +
+
+
+ event-type: + string + + +
+
+
+ +
+
+
+ version: + string + + +
+
+
+ +
+
+
+ action: + string + + +
+
+
+ +
+
+
+ entity-type: + string + + +
+
+
+ +
+
+
+ top-entity-type: + string + + +
+
+
+ +
+
+
+ entity-link: + string + + +
+
+
+ +
+
+
+ status: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

notify: + object + + + +

+
+
+ +
+
+
+ event-id: + string + + + +
+
+
+ +
+
+
+ node-type: + string + + +
+
+
+ +
+
+
+ event-trigger: + string + + +
+
+
+ +
+
+
+ selflink: + string + + +
+
+
+ +
+
+
+ key-data: + object[] + + +
+
+ +
+ +
+ key-data + + + +
+ +
+
+
+
+
+
+
+
+
+

oam-network: + object + + + +

+
+
+
+

OAM network, to be deprecated shortly. Do not use for new purposes.

+ +
    +
  • TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
  • +
  • TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ +
+ +
+
+
+ network-uuid: + string + + + +
+
+

UUID of the network. Unique across a cloud-region

+
+ +
+
+
+ network-name: + string + + + +
+
+

Name of the network.

+
+ +
+
+
+ cvlan-tag: + integer + + + +
+
+

cvlan-id

+
+ +
+
+
+ ipv4-oam-gateway-address: + string + + +
+
+

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

+
+ +
+
+
+ ipv4-oam-gateway-address-prefix-length: + integer + + +
+
+

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

oam-networks: + object + + + +

+
+
+
+

Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.

+ +
+ +
+
+
+ oam-network: + object[] + + +
+
+ +
+ +
+ oam-network + + + +
+ +
+
+
+
+
+
+
+
+
+

operational-environment: + object + + + +

+
+
+
+

It is a logical partition of the cloud which allows to have multiple environments in the production AIC.

+ +
    +
  • TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
  • +
  • FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ +
+ +
+
+
+ operational-environment-id: + string + + + +
+
+

UUID of an operational environment

+
+ +
+
+
+ operational-environment-name: + string + + + +
+
+

Operational Environment name

+
+ +
+
+
+ operational-environment-type: + string + + + +
+
+

Operational Environment Type.

+
+ +
+
+
+ operational-environment-status: + string + + + +
+
+

Status

+
+ +
+
+
+ tenant-context: + string + + + +
+
+

Tenant Context.

+
+ +
+
+
+ workload-context: + string + + + +
+
+

Workload Context.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

operational-environments: + object + + + +

+
+
+
+

a logical partition of the cloud which allows to have multiple environments in the production AIC.

+ +
+ +
+
+
+ operational-environment: + object[] + + +
+
+ +
+ +
+ operational-environment + + + +
+ +
+
+
+
+
+
+
+
+
+

overloaded-model: + object + + + +

+
+
+
+

Allows for legacy POST of old-style and new-style models

+ +
+ +
+
+
+ model-invariant-id: + string + + + +
+
+

Unique identifier corresponding to the main definition of a model in ASDC

+
+ +
+
+
+ model-name-version-id: + string + + + +
+
+

Unique identifier corresponding to one version of a model in ASDC

+
+ +
+
+
+ model-type: + string + + + +
+
+

Type of the model, e.g., service, resource, widget, etc.

+
+ +
+
+
+ model-name: + string + + + +
+
+

Name of the model, which can change from version to version.

+
+ +
+
+
+ model-id: + string + + + +
+
+

Invariant unique ID which does not change from version to version

+
+ +
+
+
+ model-version: + string + + + +
+
+

Version

+
+ +
+
+
+ model-description: + string + + +
+
+

Description

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-vers: + object + + +
+
+ +
+ +
+ model-vers + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

owning-entities: + object + + + +

+
+
+
+

Collection of owning-entities

+ +
+ +
+
+
+ owning-entity: + object[] + + +
+
+ +
+ +
+ owning-entity + + + +
+ +
+
+
+
+
+
+
+
+
+

owning-entity: + object + + + +

+
+
+
+

describes an owning-entity

+ +
    +
  • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ +
+ +
+
+
+ owning-entity-id: + string + + + +
+
+

UUID of an owning entity

+
+ +
+
+
+ owning-entity-name: + string + + + +
+
+

Owning entity name

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

p-interface: + object + + + +

+
+
+
+

Physical interface (e.g., nic)

+ +
    +
  • TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
  • +
  • TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
  • +
  • TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
  • +
  • TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
  • +
  • TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
  • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
  • +
  • FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
  • +
  • FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
  • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
  • +
  • P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
  • +
  • P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name that identifies the physical interface

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details.

+
+ +
+
+
+ speed-value: + string + + +
+
+

Captures the numeric part of the speed

+
+ +
+
+
+ speed-units: + string + + +
+
+

Captures the units corresponding to the speed

+
+ +
+
+
+ port-description: + string + + +
+
+

Nature of the services and connectivity on this port.

+
+ +
+
+
+ equipment-identifier: + string + + +
+
+

CLEI or other specification for p-interface hardware.

+
+ +
+
+
+ interface-role: + string + + +
+
+

Role specification for p-interface hardware.

+
+ +
+
+
+ interface-type: + string + + +
+
+

Indicates the physical properties of the interface.

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this resource by Service Assurance systems.

+
+ +
+
+
+ mac-addresss: + string + + +
+
+

MAC Address of the p-interface.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ inv-status: + string + + +
+
+

inventory status

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ sriov-pfs: + object[] + + +
+
+ +
+ +
+ sriov-pf + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

p-interfaces: + object + + + +

+
+
+
+

Collection of physical interfaces.

+ +
+ +
+
+
+ p-interface: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

platform: + object + + + +

+
+
+
+

describes a platform

+ +
    +
  • TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ +
+ +
+
+
+ platform-name: + string + + + +
+
+

Name of the platform

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

platforms: + object + + + +

+
+
+
+

Collection of platforms

+ +
+ +
+
+
+ platform: + object[] + + +
+
+ +
+ +
+ platform + + + +
+ +
+
+
+
+
+
+
+
+
+

pnf: + object + + + +

+
+
+
+

PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.

+ +
    +
  • TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
  • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
  • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
  • +
  • FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
  • +
  • PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ +
+ +
+
+
+ pnf-name: + string + + + +
+
+

unique name of Physical Network Function.

+
+ +
+
+
+ pnf-name2: + string + + +
+
+

name of Physical Network Function.

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details.

+
+ +
+
+
+ pnf-name2-source: + string + + +
+
+

source of name2

+
+ +
+
+
+ pnf-id: + string + + +
+
+

id of pnf

+
+ +
+
+
+ equip-type: + string + + +
+
+

Equipment type. Source of truth should define valid values.

+
+ +
+
+
+ equip-vendor: + string + + +
+
+

Equipment vendor. Source of truth should define valid values.

+
+ +
+
+
+ equip-model: + string + + +
+
+

Equipment model. Source of truth should define valid values.

+
+ +
+
+
+ management-option: + string + + +
+
+

identifier of managed by ATT or customer

+
+ +
+
+
+ ipaddress-v4-oam: + string + + +
+
+

ipv4-oam-address with new naming convention for IP addresses

+
+ +
+
+
+ sw-version: + string + + +
+
+

sw-version is the version of SW for the hosted application on the PNF.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ frame-id: + string + + +
+
+

ID of the physical frame (relay rack) where pnf is installed.

+
+ +
+
+
+ serial-number: + string + + +
+
+

Serial number of the device

+
+ +
+
+
+ ipaddress-v4-loopback-0: + string + + +
+
+

IPV4 Loopback 0 address

+
+ +
+
+
+ ipaddress-v6-loopback-0: + string + + +
+
+

IPV6 Loopback 0 address

+
+ +
+
+
+ ipaddress-v4-aim: + string + + +
+
+

IPV4 AIM address

+
+ +
+
+
+ ipaddress-v6-aim: + string + + +
+
+

IPV6 AIM address

+
+ +
+
+
+ ipaddress-v6-oam: + string + + +
+
+

IPV6 OAM address

+
+ +
+
+
+ inv-status: + string + + +
+
+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

+
+ +
+
+
+ nf-role: + string + + +
+
+

Nf Role is the role performed by this instance in the network.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ p-interfaces: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

pnfs: + object + + + +

+
+
+
+

Collection of Physical Network Functions.

+ +
+ +
+
+
+ pnf: + object[] + + +
+
+ +
+ +
+ pnf + + + +
+ +
+
+
+
+
+
+
+
+
+

port-group: + object + + + +

+
+
+
+

Used to capture the network interfaces of this VCE

+ +
    +
  • TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
  • +
  • FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
  • +
  • PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
+ +
+ +
+
+
+ interface-id: + string + + + +
+
+

Unique ID of the interface

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of this Interface

+
+ +
+
+
+ neutron-network-name: + string + + +
+
+

Neutron network name of this Interface

+
+ +
+
+
+ interface-role: + string + + +
+
+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ port-group-id: + string + + +
+
+

Unique ID for port group in vmware

+
+ +
+
+
+ port-group-name: + string + + +
+
+

Likely to duplicate value of neutron network name

+
+ +
+
+
+ switch-name: + string + + +
+
+

DVS or standard switch name (should be non-null for port groups associated with DVS)

+
+ +
+
+
+ orchestration-status: + string + + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ cvlan-tags: + object[] + + +
+
+ +
+ +
+ cvlan-tag-entry + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

port-groups: + object + + + +

+
+
+ +
+
+
+ port-group: + object[] + + +
+
+ +
+ +
+ port-group + + + +
+ +
+
+
+
+
+
+
+
+
+

project: + object + + + +

+
+
+
+

describes the project

+ +
    +
  • TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ +
+ +
+
+
+ project-name: + string + + + +
+
+

Name of the project deploying a service

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

projects: + object + + + +

+
+
+
+

Collection of projects

+ +
+ +
+
+
+ project: + object[] + + +
+
+ +
+ +
+ project + + + +
+ +
+
+
+
+
+
+
+
+
+

properties: + object + + + +

+
+
+
+

Property holder for query properties or instance properties

+ +
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

property-constraint: + object + + + +

+
+
+
+

TBD

+ +
    +
  • TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ +
+ +
+
+
+ property-constraint-uuid: + string + + + +
+
+
+ +
+
+
+ constraint-type: + string + + + +
+
+
+ +
+
+
+ property-name: + string + + + +
+
+
+ +
+
+
+ property-value: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

property-constraints: + object + + + +

+
+
+ +
+
+
+ property-constraint: + object[] + + +
+
+ +
+ +
+ property-constraint + + + +
+ +
+
+
+
+
+
+
+
+
+

pserver: + object + + + +

+
+
+
+

Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

+ +
    +
  • TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
  • +
  • TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
  • +
  • TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
  • +
  • TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
  • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
  • +
  • FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
  • +
  • PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
  • +
  • PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
  • +
  • PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
+ +
+ +
+
+
+ hostname: + string + + + +
+
+

Value from executing hostname on the compute node.

+
+ +
+
+
+ ptnii-equip-name: + string + + +
+
+

PTNII name

+
+ +
+
+
+ number-of-cpus: + integer + + +
+
+

Number of cpus

+
+ +
+
+
+ disk-in-gigabytes: + integer + + +
+
+

Disk size, in GBs

+
+ +
+
+
+ ram-in-megabytes: + integer + + +
+
+

RAM size, in MBs

+
+ +
+
+
+ equip-type: + string + + +
+
+

Equipment type. Source of truth should define valid values.

+
+ +
+
+
+ equip-vendor: + string + + +
+
+

Equipment vendor. Source of truth should define valid values.

+
+ +
+
+
+ equip-model: + string + + +
+
+

Equipment model. Source of truth should define valid values.

+
+ +
+
+
+ fqdn: + string + + +
+
+

Fully-qualified domain name

+
+ +
+
+
+ pserver-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Used to configure device, also used for troubleshooting and is IP used for traps generated by device.

+
+ +
+
+
+ serial-number: + string + + +
+
+

Serial number, may be queried

+
+ +
+
+
+ ipaddress-v4-loopback-0: + string + + +
+
+

IPV4 Loopback 0 address

+
+ +
+
+
+ ipaddress-v6-loopback-0: + string + + +
+
+

IPV6 Loopback 0 address

+
+ +
+
+
+ ipaddress-v4-aim: + string + + +
+
+

IPV4 AIM address

+
+ +
+
+
+ ipaddress-v6-aim: + string + + +
+
+

IPV6 AIM address

+
+ +
+
+
+ ipaddress-v6-oam: + string + + +
+
+

IPV6 OAM address

+
+ +
+
+
+ inv-status: + string + + +
+
+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
+ +
+
+
+ pserver-id: + string + + +
+
+

ID of Pserver

+
+ +
+
+
+ internet-topology: + string + + +
+
+

internet topology of Pserver

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ pserver-name2: + string + + +
+
+

alternative pserver name

+
+ +
+
+
+ purpose: + string + + +
+
+

purpose of pserver

+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

+
+ +
+
+
+ management-option: + string + + +
+
+

Indicates who owns and or manages the device.

+
+ +
+
+
+ host-profile: + string + + +
+
+

The host profile that defines the configuration of the pserver.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ p-interfaces: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

pservers: + object + + + +

+
+
+
+

Collection of compute hosts.

+ +
+ +
+
+
+ pserver: + object[] + + +
+
+ +
+ +
+ pserver + + + +
+ +
+
+
+
+
+
+
+
+
+

query-parameters: + object + + + +

+
+
+
+

QueryParameters for performing a named-query or model query

+ +
+ +
+
+
+ named-query: + object + + +
+
+ +
+ +
+ named-query + + + +
+ +
+
+
+
+ overloaded-model: + object + + +
+
+ +
+ +
+ overloaded-model + + + +
+ +
+
+
+
+
+
+
+ + + +
+
+

relationship: + object + + + +

+
+
+ +
+
+
+ related-to: + string + + +
+
+

A keyword provided by A&AI to indicate type of node.

+
+ +
+
+
+ relationship-label: + string + + +
+
+

The edge label for this relationship.

+
+ +
+
+
+ related-link: + string + + +
+
+

URL to the object in A&AI.

+
+ +
+
+
+ relationship-data: + object[] + + +
+
+ +
+ +
+ relationship-data + + + +
+ +
+
+
+
+
+
+
+
+
+

relationship-data: + object + + + +

+
+
+ +
+
+
+ relationship-key: + string + + + +
+
+

A keyword provided by A&AI to indicate an attribute.

+
+ +
+
+
+ relationship-value: + string + + + +
+
+

Value of the attribute.

+
+ +
+
+
+
+
+
+
+
+

relationship-list: + object + + + +

+
+
+ +
+
+
+ relationship: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

reserved-prop-names: + object + + + +

+
+
+
+

Internal map to define some reserved properties of a vertex

+ +
+ +
+
+
+ last-mod-source-of-truth: + string + + +
+
+
+ +
+
+
+ aai-node-type: + string + + +
+
+
+ +
+
+
+ aai-created-ts: + integer + + +
+
+
+ +
+
+
+ aai-unique-key: + string + + +
+
+
+ +
+
+
+ aai-last-mod-ts: + integer + + +
+
+
+ +
+
+
+ source-of-truth: + string + + +
+
+
+ +
+
+
+ aai-uri: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

response-list: + object + + + +

+
+
+
+

Response container for the results of a named-query or model query

+ +
+ +
+
+
+ inventory-response-items: + object + + +
+
+ +
+ +
+ inventory-response-items + + + +
+ +
+
+
+
+
+
+
+
+
+

result-data: + object + + + +

+
+
+ +
+
+
+ resource-type: + string + + +
+
+

The specific type of node in the A&AI graph

+
+ +
+
+
+ resource-link: + string + + +
+
+

The URL to the specific resource

+
+ +
+
+
+
+
+
+
+
+

route-table-reference: + object + + + +

+
+
+
+

Openstack route table reference.

+ +
    +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ +
+ +
+
+
+ route-table-reference-id: + string + + + +
+
+

Route Table Reference id, UUID assigned to this instance.

+
+ +
+
+
+ route-table-reference-fqdn: + string + + + +
+
+

FQDN entry in the route table.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

route-table-references: + object + + + +

+
+
+
+

Collection of openstack route table references

+ +
+ +
+
+
+ route-table-reference: + object[] + + +
+
+ +
+ +
+ route-table-reference + + + +
+ +
+
+
+
+
+
+
+
+
+

route-target: + object + + + +

+
+
+
+

Route target information

+ +
    +
  • TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ +
+ +
+
+
+ global-route-target: + string + + + +
+
+

Number used to identify an RT, globally unique in the network

+
+ +
+
+
+ route-target-role: + string + + + +
+
+

Role assigned to this route target

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

route-targets: + object + + + +

+
+
+
+

Collection of route target information

+ +
+ +
+
+
+ route-target: + object[] + + +
+
+ +
+ +
+ route-target + + + +
+ +
+
+
+
+
+
+
+
+
+

routing-instance: + object + + + +

+
+
+
+ +
    +
  • TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
  • +
  • FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
  • +
  • ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
+ +
+ +
+
+
+ routing-instance-id: + string + + + +
+
+

Unique id of routing instance

+
+ +
+
+
+ rpm-owner: + string + + +
+
+

rpm owner

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ site-pairs: + object[] + + +
+
+ +
+ +
+ site-pair + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

routing-instances: + object + + + +

+
+
+
+

set of probes related to generic-vnf routing instance

+ +
+ +
+
+
+ routing-instance: + object[] + + +
+
+ +
+ +
+ routing-instance + + + +
+ +
+
+
+
+
+
+
+
+
+

sdn-zone-response: + object + + + +

+
+
+ +
+
+
+ oam-networks: + object + + +
+
+ +
+ +
+ oam-networks + + + +
+ +
+
+
+
+ az-and-dvs-switches: + object[] + + +
+
+ +
+ +
+ az-and-dvs-switches + + + +
+ +
+
+
+
+
+
+
+ +
+
+

search-results: + object + + + +

+
+
+ +
+
+
+ result-data: + object[] + + +
+
+ +
+ +
+ result-data + + + +
+ +
+
+
+
+
+
+
+
+
+

secondary-filt: + object + + + +

+
+
+
+

SecondaryFilt for performing a named-query or model query

+ +
+ +
+
+
+
+
+
+
+
+

secondary-filter: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ filter-type: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

secondary-filts: + object + + + +

+
+
+
+

SecondaryFilts for performing a named-query or model query

+ +
+ +
+
+
+ secondary-filt: + object[] + + +
+
+ +
+ +
+ secondary-filt + + + +
+ +
+
+
+
+
+
+
+
+
+

segmentation-assignment: + object + + + +

+
+
+
+

Openstack segmentation assignment.

+ +
    +
  • TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ +
+ +
+
+
+ segmentation-id: + string + + + +
+
+

Route Table Reference id, UUID assigned to this instance.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

segmentation-assignments: + object + + + +

+
+
+
+

Collection of openstack segmentation assignments

+ +
+ +
+
+
+ segmentation-assignment: + object[] + + +
+
+ +
+ +
+ segmentation-assignment + + + +
+ +
+
+
+
+
+
+
+
+
+

service: + object + + + +

+
+
+
+

Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.

+ +
+ +
+
+
+ service-id: + string + + + +
+
+

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
+ +
+
+
+ service-description: + string + + + +
+
+

Description of the service

+
+ +
+
+
+ service-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ service-version: + string + + +
+
+

service version

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

service-capabilities: + object + + + +

+
+
+
+

Collection of service capabilities.

+ +
+ +
+
+
+ service-capability: + object[] + + +
+
+ +
+ +
+ service-capability + + + +
+ +
+
+
+
+
+
+
+
+
+

service-capability: + object + + + +

+
+
+
+

Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.

+ +
    +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
  • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
  • +
  • SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
+ +
+ +
+
+
+ service-type: + string + + + +
+
+

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

service-design-and-creation: + object + + + +

+
+
+
+

Namespace for objects managed by ASDC

+ +
+ +
+
+
+ vnf-images: + object[] + + +
+
+ +
+ +
+ vnf-image + + + +
+ +
+
+
+
+ services: + object[] + + +
+
+ +
+ +
+ service + + + +
+ +
+
+
+
+ service-capabilities: + object[] + + +
+
+ +
+ +
+ service-capability + + + +
+ +
+
+
+
+ models: + object[] + + +
+
+ +
+ +
+ model + + + +
+ +
+
+
+
+ named-queries: + object[] + + +
+
+ +
+ +
+ named-query + + + +
+ +
+
+
+
+
+
+
+
+
+

service-instance: + object + + + +

+
+
+
+

Instance of a service

+ +
    +
  • TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
  • +
  • TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
  • +
  • TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
  • +
  • TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
  • +
  • TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
  • +
  • TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
  • +
  • TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
  • +
  • TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
  • +
  • TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
  • +
  • TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
  • +
  • TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
  • +
  • TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
  • +
  • TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
  • +
  • TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
  • +
  • TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
  • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
  • +
  • FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
  • +
  • SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
  • +
  • SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ +
+ +
+
+
+ service-instance-id: + string + + + +
+
+

Uniquely identifies this instance of a service

+
+ +
+
+
+ service-instance-name: + string + + +
+
+

This field will store a name assigned to the service-instance.

+
+ +
+
+
+ service-type: + string + + + +
+
+

String capturing type of service.

+
+ +
+
+
+ service-role: + string + + + +
+
+

String capturing the service role.

+
+ +
+
+
+ environment-context: + string + + +
+
+

This field will store the environment context assigned to the service-instance.

+
+ +
+
+
+ workload-context: + string + + +
+
+

This field will store the workload context assigned to the service-instance.

+
+ +
+
+
+ created-at: + string + + + +
+
+

create time of Network Service.

+
+ +
+
+
+ updated-at: + string + + + +
+
+

last update of Network Service.

+
+ +
+
+
+ description: + string + + + +
+
+

short description for service-instance.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
+ +
+
+
+ bandwidth-total: + string + + +
+
+

Indicates the total bandwidth to be used for this service.

+
+ +
+
+
+ bandwidth-up-wan1: + string + + +
+
+

indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.

+
+ +
+
+
+ bandwidth-down-wan1: + string + + +
+
+

indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.

+
+ +
+
+
+ bandwidth-up-wan2: + string + + +
+
+

indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.

+
+ +
+
+
+ bandwidth-down-wan2: + string + + +
+
+

indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.

+
+ +
+
+
+ vhn-portal-url: + string + + +
+
+

URL customers will use to access the vHN Portal.

+
+ +
+
+
+ service-instance-location-id: + string + + +
+
+

An identifier that customers assign to the location where this service is being used.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this service.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+ allotted-resources: + object[] + + +
+
+ +
+ +
+ allotted-resource + + + +
+ +
+
+
+
+
+
+
+
+
+

service-instances: + object + + + +

+
+
+
+

Collection of service instances

+ +
+ +
+
+
+ service-instance: + object[] + + +
+
+ +
+ +
+ service-instance + + + +
+ +
+
+
+
+
+
+
+
+
+

service-subscription: + object + + + +

+
+
+
+

Object that group service instances.

+ +
    +
  • TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
  • +
  • TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
  • +
  • SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
+ +
+ +
+
+
+ service-type: + string + + + +
+
+

Value defined by orchestration to identify this service across ECOMP.

+
+ +
+
+
+ temp-ub-sub-account-id: + string + + +
+
+

This property will be deleted from A&AI in the near future. Only stop gap solution.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ service-instances: + object[] + + +
+
+ +
+ +
+ service-instance + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

service-subscriptions: + object + + + +

+
+
+
+

Collection of objects that group service instances.

+ +
+ +
+
+
+ service-subscription: + object[] + + +
+
+ +
+ +
+ service-subscription + + + +
+ +
+
+
+
+
+
+
+
+
+

services: + object + + + +

+
+
+
+

Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.

+ +
+ +
+
+
+ service: + object[] + + +
+
+ +
+ +
+ service + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pair: + object + + + +

+
+
+
+ +
    +
  • TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
  • +
  • FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
  • +
  • SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
+ +
+ +
+
+
+ site-pair-id: + string + + + +
+
+

unique identifier of probe

+
+ +
+
+
+ source-ip: + string + + +
+
+

Prefix address

+
+ +
+
+
+ destination-ip: + string + + +
+
+

Prefix address

+
+ +
+
+
+ ip-version: + string + + +
+
+

ip version, v4, v6

+
+ +
+
+
+ destination-hostname: + string + + +
+
+

Hostname of the destination equipment to which SLAs are measured against.

+
+ +
+
+
+ destination-equip-type: + string + + +
+
+

The type of destinatination equipment. Could be Router, UCPE, etc.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ classes-of-service: + object[] + + +
+
+ +
+ +
+ class-of-service + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pair-set: + object + + + +

+
+
+
+

Set of instances for probes used to measure service level agreements

+ +
    +
  • TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
  • +
  • FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
  • +
  • SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ +
+ +
+
+
+ site-pair-set-id: + string + + + +
+
+

Unique id of site pair set.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ routing-instances: + object[] + + +
+
+ +
+ +
+ routing-instance + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pair-sets: + object + + + +

+
+
+
+

Collection of sets of instances for probes related to generic-vnf

+ +
+ +
+
+
+ site-pair-set: + object[] + + +
+
+ +
+ +
+ site-pair-set + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pairs: + object + + + +

+
+
+
+

probe within a set

+ +
+ +
+
+
+ site-pair: + object[] + + +
+
+ +
+ +
+ site-pair + + + +
+ +
+
+
+
+
+
+
+
+
+

snapshot: + object + + + +

+
+
+
+

Openstack snapshot

+ +
    +
  • TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ +
+ +
+
+
+ snapshot-id: + string + + + +
+
+

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
+ +
+
+
+ snapshot-name: + string + + +
+
+

Snapshot name

+
+ +
+
+
+ snapshot-architecture: + string + + +
+
+

Operating system architecture

+
+ +
+
+
+ snapshot-os-distro: + string + + +
+
+

The common name of the operating system distribution in lowercase

+
+ +
+
+
+ snapshot-os-version: + string + + +
+
+

The operating system version as specified by the distributor.

+
+ +
+
+
+ application: + string + + +
+
+

The application that the image instantiates.

+
+ +
+
+
+ application-vendor: + string + + +
+
+

The vendor of the application.

+
+ +
+
+
+ application-version: + string + + +
+
+

The version of the application.

+
+ +
+
+
+ snapshot-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ prev-snapshot-id: + string + + +
+
+

This field contains the UUID of the previous snapshot (if any).

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

snapshots: + object + + + +

+
+
+
+

Collection of openstack snapshots

+ +
+ +
+
+
+ snapshot: + object[] + + +
+
+ +
+ +
+ snapshot + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-pf: + object + + + +

+
+
+
+

SR-IOV Physical Function

+ +
    +
  • TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
  • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ +
+ +
+
+
+ pf-pci-id: + string + + + +
+
+

Identifier for the sriov-pf

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-pfs: + object + + + +

+
+
+
+

Collection of SR-IOV Physical Functions.

+ +
+ +
+
+
+ sriov-pf: + object[] + + +
+
+ +
+ +
+ sriov-pf + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-vf: + object + + + +

+
+
+
+

SR-IOV Virtual Function (not to be confused with virtual network function)

+ +
    +
  • TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
  • +
  • TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ +
+ +
+
+
+ pci-id: + string + + + +
+
+

PCI ID used to identify the sriov-vf

+
+ +
+
+
+ vf-vlan-filter: + string + + +
+
+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
+ +
+
+
+ vf-mac-filter: + string + + +
+
+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
+ +
+
+
+ vf-vlan-strip: + boolean + + +
+
+

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
+ +
+
+
+ vf-vlan-anti-spoof-check: + boolean + + +
+
+

This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

+
+ +
+
+
+ vf-mac-anti-spoof-check: + boolean + + +
+
+

This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

+
+ +
+
+
+ vf-mirrors: + string + + +
+
+

This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.

+
+ +
+
+
+ vf-broadcast-allow: + boolean + + +
+
+

This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM

+
+ +
+
+
+ vf-unknown-multicast-allow: + boolean + + +
+
+

This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM

+
+ +
+
+
+ vf-unknown-unicast-allow: + boolean + + +
+
+

This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM

+
+ +
+
+
+ vf-insert-stag: + boolean + + +
+
+

This option, if set to true, instructs to insert outer tag after traffic comes out of VM.

+
+ +
+
+
+ vf-link-status: + string + + +
+
+

This option is used to set the link status. Valid values as of 1607 are on, off, and auto.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-vfs: + object + + + +

+
+
+
+

Collection of SR-IOV Virtual Functions.

+ +
+ +
+
+
+ sriov-vf: + object[] + + +
+
+ +
+ +
+ sriov-vf + + + +
+ +
+
+
+
+
+
+
+
+
+

start-node-filter: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

subnet: + object + + + +

+
+
+
+ +
    +
  • TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
  • +
  • FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
  • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
  • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
  • +
  • SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
  • +
  • SUBNET is DELETED when these are DELETED HOST-ROUTE
+ +
+ +
+
+
+ subnet-id: + string + + + +
+
+

Subnet ID, should be UUID.

+
+ +
+
+
+ subnet-name: + string + + +
+
+

Name associated with the subnet.

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of this subnet

+
+ +
+
+
+ gateway-address: + string + + +
+
+

gateway ip address

+
+ +
+
+
+ network-start-address: + string + + +
+
+

network start address

+
+ +
+
+
+ cidr-mask: + string + + +
+
+

cidr mask

+
+ +
+
+
+ ip-version: + string + + +
+
+

ip version

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ dhcp-enabled: + boolean + + + +
+
+
+ +
+
+
+ dhcp-start: + string + + +
+
+

the start address reserved for use by dhcp

+
+ +
+
+
+ dhcp-end: + string + + +
+
+

the last address reserved for use by dhcp

+
+ +
+
+
+ subnet-role: + string + + +
+
+

role of the subnet, referenced when assigning IPs

+
+ +
+
+
+ ip-assignment-direction: + string + + +
+
+

ip address assignment direction of the subnet

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ subnet-sequence: + integer + + +
+
+

sequence of the subnet

+
+ +
+
+
+ host-routes: + object[] + + +
+
+ +
+ +
+ host-route + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

subnets: + object + + + +

+
+
+ +
+
+
+ subnet: + object[] + + +
+
+ +
+ +
+ subnet + + + +
+ +
+
+
+
+
+
+
+
+
+

tagged-inventory-item-list: + object + + + +

+
+
+ +
+
+
+ inventory-item: + object[] + + +
+
+ +
+ +
+ inventory-item + + + +
+ +
+
+
+
+
+
+
+
+
+

tenant: + object + + + +

+
+
+
+

Openstack tenant

+ +
    +
  • TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
  • +
  • TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
  • +
  • TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
  • +
  • FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
  • +
  • FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
  • +
  • TENANT cannot be deleted if linked to VSERVER
+ +
+ +
+
+
+ tenant-id: + string + + + +
+
+

Unique id relative to the cloud-region.

+
+ +
+
+
+ tenant-name: + string + + + +
+
+

Readable name of tenant

+
+ +
+
+
+ tenant-context: + string + + +
+
+

This field will store the tenant context.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ vservers: + object[] + + +
+
+ +
+ +
+ vserver + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

tenants: + object + + + +

+
+
+
+

Collection of openstack tenants.

+ +
+ +
+
+
+ tenant: + object[] + + +
+
+ +
+ +
+ tenant + + + +
+ +
+
+
+
+
+
+
+
+
+

tunnel-xconnect: + object + + + +

+
+
+
+

Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

+ +
    +
  • TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ +
+ +
+
+
+ id: + string + + + +
+
+

Allotted Resource id UUID assigned to this instance.

+
+ +
+
+
+ bandwidth-up-wan1: + string + + +
+
+

The WAN uplink bandwidth for WAN1

+
+ +
+
+
+ bandwidth-down-wan1: + string + + +
+
+

The WAN downlink bandwidth for WAN1

+
+ +
+
+
+ bandwidth-up-wan2: + string + + +
+
+

The WAN uplink bandwidth for WAN2

+
+ +
+
+
+ bandwidth-down-wan2: + string + + +
+
+

The WAN downlink bandwidth for WAN2

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

tunnel-xconnects: + object + + + +

+
+
+
+

This object is used to store the specific tunnel cross connect aspects of an allotted resource

+ +
+ +
+
+
+ tunnel-xconnect: + object[] + + +
+
+ +
+ +
+ tunnel-xconnect + + + +
+ +
+
+
+
+
+
+
+
+
+

update: + object + + + +

+
+
+
+

Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.

+ +
+ +
+
+
+ update-node-type: + string + + + +
+
+
+ +
+
+
+ update-node-uri: + string + + +
+
+
+ +
+
+
+ update-node-key: + object[] + + +
+
+ +
+ +
+ update-node-key + + + +
+ +
+
+
+
+ action: + object[] + + +
+
+ +
+ +
+ action + + + +
+ +
+
+
+
+
+
+
+
+
+

update-node-key: + object + + + +

+
+
+ +
+
+
+ key-name: + string + + +
+
+
+ +
+
+
+ key-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

vce: + object + + + +

+
+
+
+

Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.

+ +
    +
  • TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
  • +
  • TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
  • +
  • TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
  • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
  • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
  • +
  • FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
  • +
  • VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
+ +
+ +
+
+
+ vnf-id: + string + + + +
+
+

Unique id of VNF. This is unique across the graph.

+
+ +
+
+
+ vnf-name: + string + + + +
+
+

Name of VNF.

+
+ +
+
+
+ vnf-name2: + string + + +
+
+

Alternate name of VNF.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ service-id: + string + + +
+
+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
+ +
+
+
+ regional-resource-zone: + string + + +
+
+

Regional way of organizing pservers, source of truth should define values

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this resource by Service Assurance systems.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational

+
+ +
+
+
+ license-key: + string + + +
+
+

OBSOLETE - do not use

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Network role being played by this VNF

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ vpe-id: + string + + +
+
+

Unique ID of VPE connected to this VCE.

+
+ +
+
+
+ v6-vce-wan-address: + string + + +
+
+

Valid v6 IP address for the WAN Link on this router. Implied length of /64.

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ ipv4-loopback0-address: + string + + +
+
+

Loopback0 address

+
+ +
+
+
+ entitlement-resource-uuid: + string + + +
+
+

OBSOLETE - see child relationships

+
+ +
+
+
+ port-groups: + object[] + + +
+
+ +
+ +
+ port-group + + + +
+ +
+
+
+
+ licenses: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+ entitlements: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vces: + object + + + +

+
+
+
+

Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.

+ +
+ +
+
+
+ vce: + object[] + + +
+
+ +
+ +
+ vce + + + +
+ +
+
+
+
+
+
+
+
+
+

vf-module: + object + + + +

+
+
+
+

a deployment unit of VNFCs

+ +
    +
  • TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
  • +
  • TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
  • +
  • TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
  • +
  • TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
  • +
  • TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
  • +
  • VF-MODULE cannot be deleted if linked to VNFC
+ +
+ +
+
+
+ vf-module-id: + string + + + +
+
+

Unique ID of vf-module.

+
+ +
+
+
+ vf-module-name: + string + + +
+
+

Name of vf-module

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

orchestration status of this vf-module, mastered by MSO

+
+ +
+
+
+ is-base-vf-module: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+
+ +
+
+
+ contrail-service-instance-fqdn: + string + + +
+
+

the Contrail unique ID for a service-instance

+
+ +
+
+
+ module-index: + integer + + +
+
+

the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit

+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vf-modules: + object + + + +

+
+
+
+

Collection of vf-modules, a deployment unit of VNFCs

+ +
+ +
+
+
+ vf-module: + object[] + + +
+
+ +
+ +
+ vf-module + + + +
+ +
+
+
+
+
+
+
+
+
+

vig-server: + object + + + +

+
+
+
+

vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607

+ +
    +
  • TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ +
+ +
+
+
+ vig-address-type: + string + + + +
+
+

indicates whether the VIG is for AVPN or INTERNET

+
+ +
+
+
+ ipaddress-v4-vig: + string + + +
+
+

v4 IP of the vig server

+
+ +
+
+
+ ipaddress-v6-vig: + string + + +
+
+

v6 IP of the vig server

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vig-servers: + object + + + +

+
+
+ +
+
+
+ vig-server: + object[] + + +
+
+ +
+ +
+ vig-server + + + +
+ +
+
+
+
+
+
+
+
+
+

vip-ipv4-address-list: + object + + + +

+
+
+
+

IPv4 Address Range

+ +
    +
  • TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
  • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ +
+ +
+
+
+ vip-ipv4-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ vip-ipv4-prefix-length: + integer + + +
+
+

Prefix length, 32 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vip-ipv6-address-list: + object + + + +

+
+
+
+

IPv6 Address Range

+ +
    +
  • TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
  • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ +
+ +
+
+
+ vip-ipv6-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ vip-ipv6-prefix-length: + integer + + +
+
+

Prefix length, 128 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

virtual-data-center: + object + + + +

+
+
+
+

Virtual organization of cloud infrastructure elements in a data center context

+ +
    +
  • FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ +
+ +
+
+
+ vdc-id: + string + + + +
+
+

Unique ID of the vdc

+
+ +
+
+
+ vdc-name: + string + + + +
+
+

Name of the virtual data center

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

virtual-data-centers: + object + + + +

+
+
+
+

Virtual organization of cloud infrastructure elements in a data center context

+ +
+ +
+
+
+ virtual-data-center: + object[] + + +
+
+ +
+ +
+ virtual-data-center + + + +
+ +
+
+
+
+
+
+
+
+
+

vlan: + object + + + +

+
+
+
+

Definition of vlan

+ +
    +
  • TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
  • +
  • TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
  • +
  • TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
  • +
  • VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
  • +
  • VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ +
+ +
+
+
+ vlan-interface: + string + + + +
+
+

String that identifies the interface

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ speed-value: + string + + +
+
+

Captures the numeric part of the speed

+
+ +
+
+
+ speed-units: + string + + +
+
+

Captures the units corresponding to the speed

+
+ +
+
+
+ vlan-description: + string + + +
+
+

Used to describe (the service associated with) the vlan

+
+ +
+
+
+ backdoor-connection: + string + + +
+
+

Whether customer is going to use this VLAN for backdoor connection to another customer premise device.

+
+ +
+
+
+ vpn-key: + string + + +
+
+

This indicates the customers VPN ID associated with this vlan

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].

+
+ +
+
+
+ is-ip-unnumbered: + boolean + + + +
+
+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l3-interface-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv4-address-list + + + +
+ +
+
+
+
+ l3-interface-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

vlans: + object + + + +

+
+
+ +
+
+
+ vlan: + object[] + + +
+
+ +
+ +
+ vlan + + + +
+ +
+
+
+
+
+
+
+
+
+

vnf: + object + + + +

+
+
+
+

Abstract vnf class

+ +
+ +
+
+
+ vnf-id: + string + + + +
+
+

Unique id of VNF. This is unique across the graph.

+
+ +
+
+
+
+
+
+
+
+

vnf-image: + object + + + +

+
+
+
+

Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.

+ +
    +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
  • +
  • VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
+ +
+ +
+
+
+ vnf-image-uuid: + string + + + +
+
+

Unique ID of this asset

+
+ +
+
+
+ application: + string + + + +
+
+

The application that the image instantiates.

+
+ +
+
+
+ application-vendor: + string + + + +
+
+

The vendor of the application.

+
+ +
+
+
+ application-version: + string + + +
+
+

The version of the application.

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vnf-images: + object + + + +

+
+
+
+

Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.

+ +
+ +
+
+
+ vnf-image: + object[] + + +
+
+ +
+ +
+ vnf-image + + + +
+ +
+
+
+
+
+
+
+
+
+

vnfc: + object + + + +

+
+
+
+ +
    +
  • TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
  • +
  • TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • +
  • TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
  • +
  • TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
  • +
  • TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
  • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
  • +
  • VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ +
+ +
+
+
+ vnfc-name: + string + + + +
+
+

Unique ID of vnfc.

+
+ +
+
+
+ nfc-naming-code: + string + + + +
+
+

Short code that is used in naming instances of the item being modeled

+
+ +
+
+
+ nfc-function: + string + + + +
+
+

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+
+ +
+
+
+ prov-status: + string + + +
+
+

prov status of this vnfc

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by APP-C

+
+ +
+
+
+ ipaddress-v4-oam-vip: + string + + +
+
+

Oam V4 vip address of this vnfc

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ is-closed-loop-disabled: + boolean + + + +
+
+
+ +
+
+
+ group-notation: + string + + +
+
+

Group notation of VNFC

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l3-interface-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv4-address-list + + + +
+ +
+
+
+
+ l3-interface-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

vnfcs: + object + + + +

+
+
+
+

virtual network components associated with a vserver from application controller.

+ +
+ +
+
+
+ vnfc: + object[] + + +
+
+ +
+ +
+ vnfc + + + +
+ +
+
+
+
+
+
+
+
+
+

volume: + object + + + +

+
+
+
+

Ephemeral Block storage volume.

+ +
    +
  • FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ +
+ +
+
+
+ volume-id: + string + + + +
+
+

Unique ID of block storage volume relative to the vserver.

+
+ +
+
+
+ volume-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

volume-group: + object + + + +

+
+
+
+

Persistent block-level storage.

+ +
    +
  • TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
  • +
  • TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
  • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
  • +
  • FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ +
+ +
+
+
+ volume-group-id: + string + + + +
+
+

Unique ID of volume-group.

+
+ +
+
+
+ volume-group-name: + string + + + +
+
+

Name of the volume group.

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this volume-group

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this volume-group

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ vf-module-model-customization-id: + string + + +
+
+

helps relate the volume group to the vf-module whose components will require the volume group

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

volume-groups: + object + + + +

+
+
+
+

Collection of persistent block-level storage.

+ +
+ +
+
+
+ volume-group: + object[] + + +
+
+ +
+ +
+ volume-group + + + +
+ +
+
+
+
+
+
+
+
+
+

volumes: + object + + + +

+
+
+
+

Collection of ephemeral Block storage volumes.

+ +
+ +
+
+
+ volume: + object[] + + +
+
+ +
+ +
+ volume + + + +
+ +
+
+
+
+
+
+
+
+
+

vpls-pe: + object + + + +

+
+
+
+

VPLS Provider Edge routers.

+ +
    +
  • TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
  • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
  • +
  • VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ +
+ +
+
+
+ equipment-name: + string + + + +
+
+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value, e.g., VPLS-PE.

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Temporary location for stag to get to VCE

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ p-interfaces: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

vpls-pes: + object + + + +

+
+
+
+

Collection of VPLS Provider Edge routers

+ +
+ +
+
+
+ vpls-pe: + object[] + + +
+
+ +
+ +
+ vpls-pe + + + +
+ +
+
+
+
+
+
+
+
+
+

vpn-binding: + object + + + +

+
+
+
+

VPN binding

+ +
    +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
  • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
  • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
  • +
  • FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
  • +
  • VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
  • +
  • VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ +
+ +
+
+
+ vpn-id: + string + + + +
+
+

VPN ID, globally unique within A&AI

+
+ +
+
+
+ vpn-name: + string + + + +
+
+

VPN Name

+
+ +
+
+
+ vpn-platform: + string + + +
+
+

the platform associated with the VPN example AVPN, Mobility

+
+ +
+
+
+ vpn-type: + string + + +
+
+

Type of the vpn, should be taken from enumerated/valid values

+
+ +
+
+
+ vpn-region: + string + + +
+
+

region of customer vpn

+
+ +
+
+
+ customer-vpn-id: + string + + +
+
+

id for this customer vpn

+
+ +
+
+
+ route-distinguisher: + string + + +
+
+

Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ route-targets: + object[] + + +
+
+ +
+ +
+ route-target + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vpn-bindings: + object + + + +

+
+
+ +
+
+
+ vpn-binding: + object[] + + +
+
+ +
+ +
+ vpn-binding + + + +
+ +
+
+
+
+
+
+
+
+
+

vserver: + object + + + +

+
+
+
+

Virtual Servers, aka virtual machine or VM.

+ +
    +
  • TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
  • +
  • TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
  • +
  • TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
  • +
  • TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
  • +
  • TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
  • +
  • TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
  • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
  • +
  • FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
  • +
  • FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
  • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
  • +
  • FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
  • +
  • VSERVER is DELETED when these are DELETED L-INTERFACE
  • +
  • VSERVER deletion means associated objects of these types are also DELETED:VOLUME
+ +
+ +
+
+
+ vserver-id: + string + + + +
+
+

Unique identifier for this vserver relative to its tenant

+
+ +
+
+
+ vserver-name: + string + + + +
+
+

Name of vserver

+
+ +
+
+
+ vserver-name2: + string + + +
+
+

Alternative name of vserver

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this resource by Service Assurance systems.

+
+ +
+
+
+ vserver-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ is-closed-loop-disabled: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ volumes: + object[] + + +
+
+ +
+ +
+ volume + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

vservers: + object + + + +

+
+
+
+

Collection of virtual Servers, aka virtual machines or VMs.

+ +
+ +
+
+
+ vserver: + object[] + + +
+
+ +
+ +
+ vserver + + + +
+ +
+
+
+
+
+
+
+
+
+

zone: + object + + + +

+
+
+
+

A zone is a grouping of assets in a location homing to the same connections into the CBB

+ +
    +
  • TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
  • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
  • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ +
+ +
+
+
+ zone-id: + string + + + +
+
+

Code assigned by AIC to the zone

+
+ +
+
+
+ zone-name: + string + + + +
+
+

English name associated with the zone

+
+ +
+
+
+ design-type: + string + + + +
+
+

Design of zone [Medium/Largeā€¦]

+
+ +
+
+
+ zone-context: + string + + + +
+
+

Context of zone [production/test]

+
+ +
+
+
+ status: + string + + +
+
+

Status of a zone.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

zones: + object + + + +

+
+
+
+

Collection of zones

+ +
+ +
+
+
+ zone: + object[] + + +
+
+ +
+ +
+ zone + + + +
+ +
+
+
+
+
+
+
+
+ + diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml index 22919ea2..b1d047e2 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml @@ -53540,7 +53540,7 @@ definitions: $ref: "#/definitions/operational-environment" cloud-region: description: | - cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname + cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) @@ -53593,6 +53593,12 @@ definitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -53735,7 +53741,7 @@ definitions: $ref: "#/definitions/complex" configuration: description: | - Generic configuration object. + Port Mirror Configuration. ###### Related Nodes - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) @@ -53754,6 +53760,10 @@ definitions: - configuration-id - configuration-type - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id properties: configuration-id: type: string @@ -56607,6 +56617,9 @@ definitions: prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -59036,7 +59049,7 @@ patchDefinitions: $ref: "#/patchDefinitions/operational-environment" cloud-region: description: | - cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname + cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) @@ -59089,6 +59102,12 @@ patchDefinitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. cloud-regions: properties: cloud-region: @@ -59144,7 +59163,7 @@ patchDefinitions: $ref: "#/patchDefinitions/complex" configuration: description: | - Generic configuration object. + Port Mirror Configuration. ###### Related Nodes - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) @@ -59163,6 +59182,10 @@ patchDefinitions: - configuration-id - configuration-type - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id properties: configuration-id: type: string @@ -61314,6 +61337,9 @@ patchDefinitions: prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. p-interfaces: description: | Collection of physical interfaces. @@ -63264,7 +63290,7 @@ getDefinitions: $ref: "#/getDefinitions/operational-environment" cloud-region: description: | - cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname + cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) @@ -63317,6 +63343,12 @@ getDefinitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -63459,7 +63491,7 @@ getDefinitions: $ref: "#/getDefinitions/complex" configuration: description: | - Generic configuration object. + Port Mirror Configuration. ###### Related Nodes - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) @@ -63478,6 +63510,10 @@ getDefinitions: - configuration-id - configuration-type - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id properties: configuration-id: type: string @@ -66331,6 +66367,9 @@ getDefinitions: prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml new file mode 100644 index 00000000..91ae2515 --- /dev/null +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml @@ -0,0 +1,68602 @@ +swagger: "2.0" +info: + description: | + + [Differences versus the previous schema version](apidocs/aai_swagger_v13.diff) + + Copyright © 2017 AT&T Intellectual Property. All rights reserved. + + Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License. + + You may obtain a copy of the License at + + (https://creativecommons.org/licenses/by/4.0/) + + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property. + + This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions. + version: "v13" + title: Active and Available Inventory REST API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + contact: + name: + url: + email: +host: +basePath: /aai/v13 +schemes: + - https +paths: + /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}: + get: + tags: + - CloudInfrastructure + summary: returns ctag-pool + description: returns ctag-pool + operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-pool" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: data-center-code + in: query + description: Data center code which can be an alternate way to identify a complex + required: false + type: string + - name: complex-name + in: query + description: Gamma complex name for LCP instance. + required: false + type: string + - name: identity-url + in: query + description: URL of the keystone identity service + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing ctag-pool + description: | + Create or update an existing ctag-pool. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) + required: true + schema: + $ref: "#/definitions/ctag-pool" + patch: + tags: + - CloudInfrastructure + summary: update an existing ctag-pool + description: | + Update an existing ctag-pool + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: ctag-pool object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-pool" + delete: + tags: + - CloudInfrastructure + summary: delete an existing ctag-pool + description: delete an existing ctag-pool + operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools: + get: + tags: + - CloudInfrastructure + summary: returns ctag-pools + description: returns ctag-pools + operationId: getCloudInfrastructureComplexesComplexCtagPools + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-pools" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: data-center-code + in: query + description: Data center code which can be an alternate way to identify a complex + required: false + type: string + - name: complex-name + in: query + description: Gamma complex name for LCP instance. + required: false + type: string + - name: identity-url + in: query + description: URL of the keystone identity service + required: false + type: string + /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + /cloud-infrastructure/complexes/complex/{physical-location-id}: + get: + tags: + - CloudInfrastructure + summary: returns complex + description: returns complex + operationId: getCloudInfrastructureComplexesComplex + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/complex" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: data-center-code + in: query + description: Data center code which can be an alternate way to identify a complex + required: false + type: string + - name: complex-name + in: query + description: Gamma complex name for LCP instance. + required: false + type: string + - name: identity-url + in: query + description: URL of the keystone identity service + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing complex + description: | + Create or update an existing complex. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json) + required: true + schema: + $ref: "#/definitions/complex" + patch: + tags: + - CloudInfrastructure + summary: update an existing complex + description: | + Update an existing complex + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: complex object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/complex" + delete: + tags: + - CloudInfrastructure + summary: delete an existing complex + description: delete an existing complex + operationId: deleteCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/complexes: + get: + tags: + - CloudInfrastructure + summary: returns complexes + description: returns complexes + operationId: getCloudInfrastructureComplexes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/complexes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}: + get: + tags: + - CloudInfrastructure + summary: returns volume-group + description: returns volume-group + operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: volume-group-name + in: query + description: Name of the volume group. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this volume-group + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing volume-group + description: | + Create or update an existing volume-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) + required: true + schema: + $ref: "#/definitions/volume-group" + patch: + tags: + - CloudInfrastructure + summary: update an existing volume-group + description: | + Update an existing volume-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: volume-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/volume-group" + delete: + tags: + - CloudInfrastructure + summary: delete an existing volume-group + description: delete an existing volume-group + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups: + get: + tags: + - CloudInfrastructure + summary: returns volume-groups + description: returns volume-groups + operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: + get: + tags: + - CloudInfrastructure + summary: returns volume + description: returns volume + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + put: + tags: + - CloudInfrastructure + summary: create or update an existing volume + description: | + Create or update an existing volume. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/volume" + patch: + tags: + - CloudInfrastructure + summary: update an existing volume + description: | + Update an existing volume + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/volume" + delete: + tags: + - CloudInfrastructure + summary: delete an existing volume + description: delete an existing volume + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: + get: + tags: + - CloudInfrastructure + summary: returns volumes + description: returns volumes + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volumes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - CloudInfrastructure + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - CloudInfrastructure + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: + get: + tags: + - CloudInfrastructure + summary: returns vserver + description: returns vserver + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vserver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + put: + tags: + - CloudInfrastructure + summary: create or update an existing vserver + description: | + Create or update an existing vserver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) + required: true + schema: + $ref: "#/definitions/vserver" + patch: + tags: + - CloudInfrastructure + summary: update an existing vserver + description: | + Update an existing vserver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: vserver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vserver" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vserver + description: delete an existing vserver + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers: + get: + tags: + - CloudInfrastructure + summary: returns vservers + description: returns vservers + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vservers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}: + get: + tags: + - CloudInfrastructure + summary: returns tenant + description: returns tenant + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tenant" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing tenant + description: | + Create or update an existing tenant. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) + required: true + schema: + $ref: "#/definitions/tenant" + patch: + tags: + - CloudInfrastructure + summary: update an existing tenant + description: | + Update an existing tenant + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: tenant object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/tenant" + delete: + tags: + - CloudInfrastructure + summary: delete an existing tenant + description: delete an existing tenant + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants: + get: + tags: + - CloudInfrastructure + summary: returns tenants + description: returns tenants + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tenants" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: + get: + tags: + - CloudInfrastructure + summary: returns flavor + description: returns flavor + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/flavor" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: flavor-name + in: query + description: Flavor name + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing flavor + description: | + Create or update an existing flavor. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + required: true + schema: + $ref: "#/definitions/flavor" + patch: + tags: + - CloudInfrastructure + summary: update an existing flavor + description: | + Update an existing flavor + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: flavor object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/flavor" + delete: + tags: + - CloudInfrastructure + summary: delete an existing flavor + description: delete an existing flavor + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors: + get: + tags: + - CloudInfrastructure + summary: returns flavors + description: returns flavors + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/flavors" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}: + get: + tags: + - CloudInfrastructure + summary: returns group-assignment + description: returns group-assignment + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/group-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: group-type + in: query + description: Group type - the type of group this instance refers to + required: false + type: string + - name: group-name + in: query + description: Group name - name assigned to the group + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing group-assignment + description: | + Create or update an existing group-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + required: true + schema: + $ref: "#/definitions/group-assignment" + patch: + tags: + - CloudInfrastructure + summary: update an existing group-assignment + description: | + Update an existing group-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: group-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/group-assignment" + delete: + tags: + - CloudInfrastructure + summary: delete an existing group-assignment + description: delete an existing group-assignment + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments: + get: + tags: + - CloudInfrastructure + summary: returns group-assignments + description: returns group-assignments + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/group-assignments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: + get: + tags: + - CloudInfrastructure + summary: returns snapshot + description: returns snapshot + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/snapshot" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: snapshot-name + in: query + description: Snapshot name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + - name: prev-snapshot-id + in: query + description: This field contains the UUID of the previous snapshot (if any). + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing snapshot + description: | + Create or update an existing snapshot. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + required: true + schema: + $ref: "#/definitions/snapshot" + patch: + tags: + - CloudInfrastructure + summary: update an existing snapshot + description: | + Update an existing snapshot + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: snapshot object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/snapshot" + delete: + tags: + - CloudInfrastructure + summary: delete an existing snapshot + description: delete an existing snapshot + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots: + get: + tags: + - CloudInfrastructure + summary: returns snapshots + description: returns snapshots + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/snapshots" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}: + get: + tags: + - CloudInfrastructure + summary: returns metadatum + description: returns metadatum + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: image-name + in: query + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - CloudInfrastructure + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - CloudInfrastructure + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata: + get: + tags: + - CloudInfrastructure + summary: returns metadata + description: returns metadata + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: image-name + in: query + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: + get: + tags: + - CloudInfrastructure + summary: returns image + description: returns image + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/image" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: image-name + in: query + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing image + description: | + Create or update an existing image. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + required: true + schema: + $ref: "#/definitions/image" + patch: + tags: + - CloudInfrastructure + summary: update an existing image + description: | + Update an existing image + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: image object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/image" + delete: + tags: + - CloudInfrastructure + summary: delete an existing image + description: delete an existing image + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: + get: + tags: + - CloudInfrastructure + summary: returns images + description: returns images + operationId: getCloudInfrastructureCloudRegionsCloudRegionImages + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/images" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: + get: + tags: + - CloudInfrastructure + summary: returns dvs-switch + description: returns dvs-switch + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/dvs-switch" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: vcenter-url + in: query + description: URL used to reach the vcenter + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing dvs-switch + description: | + Create or update an existing dvs-switch. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) + required: true + schema: + $ref: "#/definitions/dvs-switch" + patch: + tags: + - CloudInfrastructure + summary: update an existing dvs-switch + description: | + Update an existing dvs-switch + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: dvs-switch object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/dvs-switch" + delete: + tags: + - CloudInfrastructure + summary: delete an existing dvs-switch + description: delete an existing dvs-switch + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches: + get: + tags: + - CloudInfrastructure + summary: returns dvs-switches + description: returns dvs-switches + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/dvs-switches" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: + get: + tags: + - CloudInfrastructure + summary: returns oam-network + description: returns oam-network + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-network" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: network-name + in: query + description: Name of the network. + required: false + type: string + - name: cvlan-tag + in: query + description: cvlan-id + required: false + type: integer + format: int64 + put: + tags: + - CloudInfrastructure + summary: create or update an existing oam-network + description: | + Create or update an existing oam-network. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + required: true + schema: + $ref: "#/definitions/oam-network" + patch: + tags: + - CloudInfrastructure + summary: update an existing oam-network + description: | + Update an existing oam-network + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: oam-network object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/oam-network" + delete: + tags: + - CloudInfrastructure + summary: delete an existing oam-network + description: delete an existing oam-network + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks: + get: + tags: + - CloudInfrastructure + summary: returns oam-networks + description: returns oam-networks + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-networks" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}: + get: + tags: + - CloudInfrastructure + summary: returns availability-zone + description: returns availability-zone + operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/availability-zone" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing availability-zone + description: | + Create or update an existing availability-zone. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + required: true + schema: + $ref: "#/definitions/availability-zone" + patch: + tags: + - CloudInfrastructure + summary: update an existing availability-zone + description: | + Update an existing availability-zone + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: availability-zone object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/availability-zone" + delete: + tags: + - CloudInfrastructure + summary: delete an existing availability-zone + description: delete an existing availability-zone + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones: + get: + tags: + - CloudInfrastructure + summary: returns availability-zones + description: returns availability-zones + operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/availability-zones" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns vip-ipv4-address-list + description: returns vip-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vip-ipv4-address-list + description: | + Create or update an existing vip-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing vip-ipv4-address-list + description: | + Update an existing vip-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: vip-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vip-ipv4-address-list + description: delete an existing vip-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns vip-ipv6-address-list + description: returns vip-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vip-ipv6-address-list + description: | + Create or update an existing vip-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing vip-ipv6-address-list + description: | + Update an existing vip-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vip-ipv6-address-list + description: delete an existing vip-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: + get: + tags: + - CloudInfrastructure + summary: returns cloud-region + description: returns cloud-region + operationId: getCloudInfrastructureCloudRegionsCloudRegion + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cloud-region" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing cloud-region + description: | + Create or update an existing cloud-region. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json) + required: true + schema: + $ref: "#/definitions/cloud-region" + patch: + tags: + - CloudInfrastructure + summary: update an existing cloud-region + description: | + Update an existing cloud-region + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: cloud-region object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/cloud-region" + delete: + tags: + - CloudInfrastructure + summary: delete an existing cloud-region + description: delete an existing cloud-region + operationId: deleteCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions: + get: + tags: + - CloudInfrastructure + summary: returns cloud-regions + description: returns cloud-regions + operationId: getCloudInfrastructureCloudRegions + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cloud-regions" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}: + get: + tags: + - CloudInfrastructure + summary: returns network-profile + description: returns network-profile + operationId: getCloudInfrastructureNetworkProfilesNetworkProfile + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-profile" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing network-profile + description: | + Create or update an existing network-profile. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json) + required: true + schema: + $ref: "#/definitions/network-profile" + patch: + tags: + - CloudInfrastructure + summary: update an existing network-profile + description: | + Update an existing network-profile + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/network-profile" + delete: + tags: + - CloudInfrastructure + summary: delete an existing network-profile + description: delete an existing network-profile + operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/network-profiles: + get: + tags: + - CloudInfrastructure + summary: returns network-profiles + description: returns network-profiles + operationId: getCloudInfrastructureNetworkProfiles + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-profiles" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-pf + description: returns sriov-pf + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - CloudInfrastructure + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - CloudInfrastructure + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns p-interface + description: returns p-interface + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns p-interfaces + description: returns p-interfaces + operationId: getCloudInfrastructurePserversPserverPInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - CloudInfrastructure + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - CloudInfrastructure + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns lag-interface + description: returns lag-interface + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getCloudInfrastructurePserversPserverLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}: + get: + tags: + - CloudInfrastructure + summary: returns pserver + description: returns pserver + operationId: getCloudInfrastructurePserversPserver + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pserver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing pserver + description: | + Create or update an existing pserver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: body + in: body + description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json) + required: true + schema: + $ref: "#/definitions/pserver" + patch: + tags: + - CloudInfrastructure + summary: update an existing pserver + description: | + Update an existing pserver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: body + in: body + description: pserver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/pserver" + delete: + tags: + - CloudInfrastructure + summary: delete an existing pserver + description: delete an existing pserver + operationId: deleteCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers: + get: + tags: + - CloudInfrastructure + summary: returns pservers + description: returns pservers + operationId: getCloudInfrastructurePservers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pservers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}: + get: + tags: + - CloudInfrastructure + summary: returns virtual-data-center + description: returns virtual-data-center + operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/virtual-data-center" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: vdc-name + in: query + description: Name of the virtual data center + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing virtual-data-center + description: | + Create or update an existing virtual-data-center. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) + required: true + schema: + $ref: "#/definitions/virtual-data-center" + patch: + tags: + - CloudInfrastructure + summary: update an existing virtual-data-center + description: | + Update an existing virtual-data-center + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/virtual-data-center" + delete: + tags: + - CloudInfrastructure + summary: delete an existing virtual-data-center + description: delete an existing virtual-data-center + operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/virtual-data-centers: + get: + tags: + - CloudInfrastructure + summary: returns virtual-data-centers + description: returns virtual-data-centers + operationId: getCloudInfrastructureVirtualDataCenters + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/virtual-data-centers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}: + get: + tags: + - CloudInfrastructure + summary: returns operational-environment + description: returns operational-environment + operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/operational-environment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing operational-environment + description: | + Create or update an existing operational-environment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: body + in: body + description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) + required: true + schema: + $ref: "#/definitions/operational-environment" + patch: + tags: + - CloudInfrastructure + summary: update an existing operational-environment + description: | + Update an existing operational-environment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: body + in: body + description: operational-environment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/operational-environment" + delete: + tags: + - CloudInfrastructure + summary: delete an existing operational-environment + description: delete an existing operational-environment + operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/operational-environments: + get: + tags: + - CloudInfrastructure + summary: returns operational-environments + description: returns operational-environments + operationId: getCloudInfrastructureOperationalEnvironments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/operational-environments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessConnectorsConnectorMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Business + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/connectors/connector/{resource-instance-id}/metadata: + get: + tags: + - Business + summary: returns metadata + description: returns metadata + operationId: getBusinessConnectorsConnectorMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /business/connectors/connector/{resource-instance-id}: + get: + tags: + - Business + summary: returns connector + description: returns connector + operationId: getBusinessConnectorsConnector + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/connector" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing connector + description: | + Create or update an existing connector. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json) + required: true + schema: + $ref: "#/definitions/connector" + patch: + tags: + - Business + summary: update an existing connector + description: | + Update an existing connector + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/connector" + delete: + tags: + - Business + summary: delete an existing connector + description: delete an existing connector + operationId: deleteBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/connectors: + get: + tags: + - Business + summary: returns connectors + description: returns connectors + operationId: getBusinessConnectors + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/connectors" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Business + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata: + get: + tags: + - Business + summary: returns metadata + description: returns metadata + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}: + get: + tags: + - Business + summary: returns tunnel-xconnect + description: returns tunnel-xconnect + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tunnel-xconnect" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: type + in: query + description: Generic description of the type of allotted resource. + required: false + type: string + - name: role + in: query + description: role in the network that this resource will be providing. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing tunnel-xconnect + description: | + Create or update an existing tunnel-xconnect. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) + required: true + schema: + $ref: "#/definitions/tunnel-xconnect" + patch: + tags: + - Business + summary: update an existing tunnel-xconnect + description: | + Update an existing tunnel-xconnect + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/tunnel-xconnect" + delete: + tags: + - Business + summary: delete an existing tunnel-xconnect + description: delete an existing tunnel-xconnect + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects: + get: + tags: + - Business + summary: returns tunnel-xconnects + description: returns tunnel-xconnects + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tunnel-xconnects" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: type + in: query + description: Generic description of the type of allotted resource. + required: false + type: string + - name: role + in: query + description: role in the network that this resource will be providing. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}: + get: + tags: + - Business + summary: returns allotted-resource + description: returns allotted-resource + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/allotted-resource" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: type + in: query + description: Generic description of the type of allotted resource. + required: false + type: string + - name: role + in: query + description: role in the network that this resource will be providing. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing allotted-resource + description: | + Create or update an existing allotted-resource. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) + required: true + schema: + $ref: "#/definitions/allotted-resource" + patch: + tags: + - Business + summary: update an existing allotted-resource + description: | + Update an existing allotted-resource + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: allotted-resource object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/allotted-resource" + delete: + tags: + - Business + summary: delete an existing allotted-resource + description: delete an existing allotted-resource + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources: + get: + tags: + - Business + summary: returns allotted-resources + description: returns allotted-resources + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/allotted-resources" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: + get: + tags: + - Business + summary: returns service-instance + description: returns service-instance + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-instance" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing service-instance + description: | + Create or update an existing service-instance. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/service-instance" + patch: + tags: + - Business + summary: update an existing service-instance + description: | + Update an existing service-instance + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: service-instance object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-instance" + delete: + tags: + - Business + summary: delete an existing service-instance + description: delete an existing service-instance + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances: + get: + tags: + - Business + summary: returns service-instances + description: returns service-instances + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-instances" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}: + get: + tags: + - Business + summary: returns service-subscription + description: returns service-subscription + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-subscription" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing service-subscription + description: | + Create or update an existing service-subscription. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: body + in: body + description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) + required: true + schema: + $ref: "#/definitions/service-subscription" + patch: + tags: + - Business + summary: update an existing service-subscription + description: | + Update an existing service-subscription + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: body + in: body + description: service-subscription object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-subscription" + delete: + tags: + - Business + summary: delete an existing service-subscription + description: delete an existing service-subscription + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions: + get: + tags: + - Business + summary: returns service-subscriptions + description: returns service-subscriptions + operationId: getBusinessCustomersCustomerServiceSubscriptions + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-subscriptions" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + /business/customers/customer/{global-customer-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + /business/customers/customer/{global-customer-id}: + get: + tags: + - Business + summary: returns customer + description: returns customer + operationId: getBusinessCustomersCustomer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/customer" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing customer + description: | + Create or update an existing customer. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json) + required: true + schema: + $ref: "#/definitions/customer" + patch: + tags: + - Business + summary: update an existing customer + description: | + Update an existing customer + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: customer object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/customer" + delete: + tags: + - Business + summary: delete an existing customer + description: delete an existing customer + operationId: deleteBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers: + get: + tags: + - Business + summary: returns customers + description: returns customers + operationId: getBusinessCustomers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/customers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + /business/lines-of-business/line-of-business/{line-of-business-name}: + get: + tags: + - Business + summary: returns line-of-business + description: returns line-of-business + operationId: getBusinessLinesOfBusinessLineOfBusiness + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/line-of-business" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + put: + tags: + - Business + summary: create or update an existing line-of-business + description: | + Create or update an existing line-of-business. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json) + required: true + schema: + $ref: "#/definitions/line-of-business" + patch: + tags: + - Business + summary: update an existing line-of-business + description: | + Update an existing line-of-business + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: line-of-business object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/line-of-business" + delete: + tags: + - Business + summary: delete an existing line-of-business + description: delete an existing line-of-business + operationId: deleteBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/lines-of-business: + get: + tags: + - Business + summary: returns lines-of-business + description: returns lines-of-business + operationId: getBusinessLinesOfBusiness + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lines-of-business" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + /business/owning-entities/owning-entity/{owning-entity-id}: + get: + tags: + - Business + summary: returns owning-entity + description: returns owning-entity + operationId: getBusinessOwningEntitiesOwningEntity + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/owning-entity" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + put: + tags: + - Business + summary: create or update an existing owning-entity + description: | + Create or update an existing owning-entity. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json) + required: true + schema: + $ref: "#/definitions/owning-entity" + patch: + tags: + - Business + summary: update an existing owning-entity + description: | + Update an existing owning-entity + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: owning-entity object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/owning-entity" + delete: + tags: + - Business + summary: delete an existing owning-entity + description: delete an existing owning-entity + operationId: deleteBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/owning-entities: + get: + tags: + - Business + summary: returns owning-entities + description: returns owning-entities + operationId: getBusinessOwningEntities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/owning-entities" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/platforms/platform/{platform-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + /business/platforms/platform/{platform-name}: + get: + tags: + - Business + summary: returns platform + description: returns platform + operationId: getBusinessPlatformsPlatform + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/platform" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + put: + tags: + - Business + summary: create or update an existing platform + description: | + Create or update an existing platform. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: body + in: body + description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json) + required: true + schema: + $ref: "#/definitions/platform" + patch: + tags: + - Business + summary: update an existing platform + description: | + Update an existing platform + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: body + in: body + description: platform object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/platform" + delete: + tags: + - Business + summary: delete an existing platform + description: delete an existing platform + operationId: deleteBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/platforms: + get: + tags: + - Business + summary: returns platforms + description: returns platforms + operationId: getBusinessPlatforms + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/platforms" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/projects/project/{project-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessProjectsProjectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + /business/projects/project/{project-name}: + get: + tags: + - Business + summary: returns project + description: returns project + operationId: getBusinessProjectsProject + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/project" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + put: + tags: + - Business + summary: create or update an existing project + description: | + Create or update an existing project. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: body + in: body + description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json) + required: true + schema: + $ref: "#/definitions/project" + patch: + tags: + - Business + summary: update an existing project + description: | + Update an existing project + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: body + in: body + description: project object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/project" + delete: + tags: + - Business + summary: delete an existing project + description: delete an existing project + operationId: deleteBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/projects: + get: + tags: + - Business + summary: returns projects + description: returns projects + operationId: getBusinessProjects + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/projects" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns vnf-image + description: returns vnf-image + operationId: getServiceDesignAndCreationVnfImagesVnfImage + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnf-image" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing vnf-image + description: | + Create or update an existing vnf-image. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json) + required: true + schema: + $ref: "#/definitions/vnf-image" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing vnf-image + description: | + Update an existing vnf-image + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: vnf-image object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vnf-image" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing vnf-image + description: delete an existing vnf-image + operationId: deleteServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/vnf-images: + get: + tags: + - ServiceDesignAndCreation + summary: returns vnf-images + description: returns vnf-images + operationId: getServiceDesignAndCreationVnfImages + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnf-images" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + /service-design-and-creation/services/service/{service-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns service + description: returns service + operationId: getServiceDesignAndCreationServicesService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: service-description + in: query + description: Description of the service + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing service + description: | + Create or update an existing service. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: body + in: body + description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json) + required: true + schema: + $ref: "#/definitions/service" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing service + description: | + Update an existing service + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: body + in: body + description: service object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing service + description: delete an existing service + operationId: deleteServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/services: + get: + tags: + - ServiceDesignAndCreation + summary: returns services + description: returns services + operationId: getServiceDesignAndCreationServices + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/services" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}: + get: + tags: + - ServiceDesignAndCreation + summary: returns service-capability + description: returns service-capability + operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-capability" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing service-capability + description: | + Create or update an existing service-capability. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: body + in: body + description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) + required: true + schema: + $ref: "#/definitions/service-capability" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing service-capability + description: | + Update an existing service-capability + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: body + in: body + description: service-capability object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-capability" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing service-capability + description: delete an existing service-capability + operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/service-capabilities: + get: + tags: + - ServiceDesignAndCreation + summary: returns service-capabilities + description: returns service-capabilities + operationId: getServiceDesignAndCreationServiceCapabilities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-capabilities" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns element-choice-set + description: returns element-choice-set + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/element-choice-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing element-choice-set + description: | + Create or update an existing element-choice-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: body + in: body + description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) + required: true + schema: + $ref: "#/definitions/element-choice-set" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing element-choice-set + description: | + Update an existing element-choice-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: body + in: body + description: element-choice-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/element-choice-set" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing element-choice-set + description: delete an existing element-choice-set + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets: + get: + tags: + - ServiceDesignAndCreation + summary: returns element-choice-sets + description: returns element-choice-sets + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/element-choice-sets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns constrained-element-set + description: returns constrained-element-set + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/constrained-element-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing constrained-element-set + description: | + Create or update an existing constrained-element-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) + required: true + schema: + $ref: "#/definitions/constrained-element-set" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing constrained-element-set + description: | + Update an existing constrained-element-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: constrained-element-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/constrained-element-set" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing constrained-element-set + description: delete an existing constrained-element-set + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets: + get: + tags: + - ServiceDesignAndCreation + summary: returns constrained-element-sets + description: returns constrained-element-sets + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/constrained-element-sets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraint + description: returns model-constraint + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraint" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-constraint + description: | + Create or update an existing model-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) + required: true + schema: + $ref: "#/definitions/model-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-constraint + description: | + Update an existing model-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-element + description: returns model-element + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-element" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-element + description: | + Create or update an existing model-element. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: body + in: body + description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) + required: true + schema: + $ref: "#/definitions/model-element" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-element + description: | + Update an existing model-element + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: body + in: body + description: model-element object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-element" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-element + description: delete an existing model-element + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-elements + description: returns model-elements + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-elements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: + get: + tags: + - ServiceDesignAndCreation + summary: returns metadatum + description: returns metadatum + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata: + get: + tags: + - ServiceDesignAndCreation + summary: returns metadata + description: returns metadata + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-ver + description: returns model-ver + operationId: getServiceDesignAndCreationModelsModelModelVersModelVer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-ver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-ver + description: | + Create or update an existing model-ver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json) + required: true + schema: + $ref: "#/definitions/model-ver" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-ver + description: | + Update an existing model-ver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: model-ver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-ver" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-ver + description: delete an existing model-ver + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-vers + description: returns model-vers + operationId: getServiceDesignAndCreationModelsModelModelVers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-vers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + /service-design-and-creation/models/model/{model-invariant-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model + description: returns model + operationId: getServiceDesignAndCreationModelsModel + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model + description: | + Create or update an existing model. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json) + required: true + schema: + $ref: "#/definitions/model" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model + description: | + Update an existing model + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: model object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model + description: delete an existing model + operationId: deleteServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models: + get: + tags: + - ServiceDesignAndCreation + summary: returns models + description: returns models + operationId: getServiceDesignAndCreationModels + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/models" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns related-lookup + description: returns related-lookup + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/related-lookup" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing related-lookup + description: | + Create or update an existing related-lookup. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) + required: true + schema: + $ref: "#/definitions/related-lookup" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing related-lookup + description: | + Update an existing related-lookup + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: related-lookup object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/related-lookup" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing related-lookup + description: delete an existing related-lookup + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups: + get: + tags: + - ServiceDesignAndCreation + summary: returns related-lookups + description: returns related-lookups + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/related-lookups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: named-query-name + in: query + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns property-constraint + description: returns property-constraint + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/property-constraint" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing property-constraint + description: | + Create or update an existing property-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: body + in: body + description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json) + required: true + schema: + $ref: "#/definitions/property-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing property-constraint + description: | + Update an existing property-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: body + in: body + description: property-constraint object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/property-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing property-constraint + description: delete an existing property-constraint + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns property-constraints + description: returns property-constraints + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/property-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: named-query-name + in: query + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-query-element + description: returns named-query-element + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query-element" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing named-query-element + description: | + Create or update an existing named-query-element. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) + required: true + schema: + $ref: "#/definitions/named-query-element" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing named-query-element + description: | + Update an existing named-query-element + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: named-query-element object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query-element" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing named-query-element + description: delete an existing named-query-element + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-query-elements + description: returns named-query-elements + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query-elements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-name + in: query + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-query + description: returns named-query + operationId: getServiceDesignAndCreationNamedQueriesNamedQuery + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing named-query + description: | + Create or update an existing named-query. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json) + required: true + schema: + $ref: "#/definitions/named-query" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing named-query + description: | + Update an existing named-query + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: named-query object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing named-query + description: delete an existing named-query + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-queries + description: returns named-queries + operationId: getServiceDesignAndCreationNamedQueries + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-queries" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/logical-links/logical-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + /network/logical-links/logical-link/{link-name}: + get: + tags: + - Network + summary: returns logical-link + description: returns logical-link + operationId: getNetworkLogicalLinksLogicalLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/logical-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: link-id + in: query + description: UUID of the logical-link, SDNC generates this. + required: false + type: string + - name: circuit-id + in: query + description: Circuit id + required: false + type: string + - name: purpose + in: query + description: Reason for this entity, role it is playing + required: false + type: string + put: + tags: + - Network + summary: create or update an existing logical-link + description: | + Create or update an existing logical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json) + required: true + schema: + $ref: "#/definitions/logical-link" + patch: + tags: + - Network + summary: update an existing logical-link + description: | + Update an existing logical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/logical-link" + delete: + tags: + - Network + summary: delete an existing logical-link + description: delete an existing logical-link + operationId: deleteNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/logical-links: + get: + tags: + - Network + summary: returns logical-links + description: returns logical-links + operationId: getNetworkLogicalLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/logical-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}: + get: + tags: + - Network + summary: returns class-of-service + description: returns class-of-service + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/class-of-service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + put: + tags: + - Network + summary: create or update an existing class-of-service + description: | + Create or update an existing class-of-service. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: body + in: body + description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) + required: true + schema: + $ref: "#/definitions/class-of-service" + patch: + tags: + - Network + summary: update an existing class-of-service + description: | + Update an existing class-of-service + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: body + in: body + description: class-of-service object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/class-of-service" + delete: + tags: + - Network + summary: delete an existing class-of-service + description: delete an existing class-of-service + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service: + get: + tags: + - Network + summary: returns classes-of-service + description: returns classes-of-service + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/classes-of-service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}: + get: + tags: + - Network + summary: returns site-pair + description: returns site-pair + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + put: + tags: + - Network + summary: create or update an existing site-pair + description: | + Create or update an existing site-pair. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: body + in: body + description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) + required: true + schema: + $ref: "#/definitions/site-pair" + patch: + tags: + - Network + summary: update an existing site-pair + description: | + Update an existing site-pair + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: body + in: body + description: site-pair object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/site-pair" + delete: + tags: + - Network + summary: delete an existing site-pair + description: delete an existing site-pair + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs: + get: + tags: + - Network + summary: returns site-pairs + description: returns site-pairs + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pairs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}: + get: + tags: + - Network + summary: returns routing-instance + description: returns routing-instance + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/routing-instance" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + put: + tags: + - Network + summary: create or update an existing routing-instance + description: | + Create or update an existing routing-instance. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) + required: true + schema: + $ref: "#/definitions/routing-instance" + patch: + tags: + - Network + summary: update an existing routing-instance + description: | + Update an existing routing-instance + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: routing-instance object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/routing-instance" + delete: + tags: + - Network + summary: delete an existing routing-instance + description: delete an existing routing-instance + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances: + get: + tags: + - Network + summary: returns routing-instances + description: returns routing-instances + operationId: getNetworkSitePairSetsSitePairSetRoutingInstances + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/routing-instances" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}: + get: + tags: + - Network + summary: returns site-pair-set + description: returns site-pair-set + operationId: getNetworkSitePairSetsSitePairSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + put: + tags: + - Network + summary: create or update an existing site-pair-set + description: | + Create or update an existing site-pair-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json) + required: true + schema: + $ref: "#/definitions/site-pair-set" + patch: + tags: + - Network + summary: update an existing site-pair-set + description: | + Update an existing site-pair-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: site-pair-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/site-pair-set" + delete: + tags: + - Network + summary: delete an existing site-pair-set + description: delete an existing site-pair-set + operationId: deleteNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets: + get: + tags: + - Network + summary: returns site-pair-sets + description: returns site-pair-sets + operationId: getNetworkSitePairSets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair-sets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + get: + tags: + - Network + summary: returns route-target + description: returns route-target + operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-target" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: vpn-name + in: query + description: VPN Name + required: false + type: string + - name: vpn-type + in: query + description: Type of the vpn, should be taken from enumerated/valid values + required: false + type: string + put: + tags: + - Network + summary: create or update an existing route-target + description: | + Create or update an existing route-target. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/route-target" + patch: + tags: + - Network + summary: update an existing route-target + description: | + Update an existing route-target + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: route-target object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/route-target" + delete: + tags: + - Network + summary: delete an existing route-target + description: delete an existing route-target + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets: + get: + tags: + - Network + summary: returns route-targets + description: returns route-targets + operationId: getNetworkVpnBindingsVpnBindingRouteTargets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-targets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: vpn-name + in: query + description: VPN Name + required: false + type: string + - name: vpn-type + in: query + description: Type of the vpn, should be taken from enumerated/valid values + required: false + type: string + /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + /network/vpn-bindings/vpn-binding/{vpn-id}: + get: + tags: + - Network + summary: returns vpn-binding + description: returns vpn-binding + operationId: getNetworkVpnBindingsVpnBinding + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpn-binding" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: vpn-name + in: query + description: VPN Name + required: false + type: string + - name: vpn-type + in: query + description: Type of the vpn, should be taken from enumerated/valid values + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vpn-binding + description: | + Create or update an existing vpn-binding. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json) + required: true + schema: + $ref: "#/definitions/vpn-binding" + patch: + tags: + - Network + summary: update an existing vpn-binding + description: | + Update an existing vpn-binding + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: vpn-binding object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vpn-binding" + delete: + tags: + - Network + summary: delete an existing vpn-binding + description: delete an existing vpn-binding + operationId: deleteNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpn-bindings: + get: + tags: + - Network + summary: returns vpn-bindings + description: returns vpn-bindings + operationId: getNetworkVpnBindings + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpn-bindings" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - Network + summary: returns sriov-pf + description: returns sriov-pf + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - Network + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - Network + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - Network + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: + get: + tags: + - Network + summary: returns p-interface + description: returns p-interface + operationId: getNetworkVplsPesVplsPePInterfacesPInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - Network + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" + delete: + tags: + - Network + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces: + get: + tags: + - Network + summary: returns p-interfaces + description: returns p-interfaces + operationId: getNetworkVplsPesVplsPePInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkVplsPesVplsPeLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}: + get: + tags: + - Network + summary: returns vpls-pe + description: returns vpls-pe + operationId: getNetworkVplsPesVplsPe + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpls-pe" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vpls-pe + description: | + Create or update an existing vpls-pe. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json) + required: true + schema: + $ref: "#/definitions/vpls-pe" + patch: + tags: + - Network + summary: update an existing vpls-pe + description: | + Update an existing vpls-pe + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: vpls-pe object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vpls-pe" + delete: + tags: + - Network + summary: delete an existing vpls-pe + description: delete an existing vpls-pe + operationId: deleteNetworkVplsPesVplsPe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes: + get: + tags: + - Network + summary: returns vpls-pes + description: returns vpls-pes + operationId: getNetworkVplsPes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpls-pes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}: + get: + tags: + - Network + summary: returns multicast-configuration + description: returns multicast-configuration + operationId: getNetworkMulticastConfigurationsMulticastConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/multicast-configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + put: + tags: + - Network + summary: create or update an existing multicast-configuration + description: | + Create or update an existing multicast-configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json) + required: true + schema: + $ref: "#/definitions/multicast-configuration" + patch: + tags: + - Network + summary: update an existing multicast-configuration + description: | + Update an existing multicast-configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: multicast-configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/multicast-configuration" + delete: + tags: + - Network + summary: delete an existing multicast-configuration + description: delete an existing multicast-configuration + operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/multicast-configurations: + get: + tags: + - Network + summary: returns multicast-configurations + description: returns multicast-configurations + operationId: getNetworkMulticastConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/multicast-configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}: + get: + tags: + - Network + summary: returns cvlan-tag-entry + description: returns cvlan-tag-entry + operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cvlan-tag-entry" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + - name: port-group-id + in: query + description: Unique ID for port group in vmware + required: false + type: string + - name: switch-name + in: query + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + put: + tags: + - Network + summary: create or update an existing cvlan-tag-entry + description: | + Create or update an existing cvlan-tag-entry. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) + required: true + schema: + $ref: "#/definitions/cvlan-tag-entry" + patch: + tags: + - Network + summary: update an existing cvlan-tag-entry + description: | + Update an existing cvlan-tag-entry + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: cvlan-tag-entry object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/cvlan-tag-entry" + delete: + tags: + - Network + summary: delete an existing cvlan-tag-entry + description: delete an existing cvlan-tag-entry + operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags: + get: + tags: + - Network + summary: returns cvlan-tags + description: returns cvlan-tags + operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cvlan-tags" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + - name: port-group-id + in: query + description: Unique ID for port group in vmware + required: false + type: string + - name: switch-name + in: query + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}: + get: + tags: + - Network + summary: returns port-group + description: returns port-group + operationId: getNetworkVcesVcePortGroupsPortGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/port-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + - name: port-group-id + in: query + description: Unique ID for port group in vmware + required: false + type: string + - name: switch-name + in: query + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + put: + tags: + - Network + summary: create or update an existing port-group + description: | + Create or update an existing port-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: body + in: body + description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json) + required: true + schema: + $ref: "#/definitions/port-group" + patch: + tags: + - Network + summary: update an existing port-group + description: | + Update an existing port-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: body + in: body + description: port-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/port-group" + delete: + tags: + - Network + summary: delete an existing port-group + description: delete an existing port-group + operationId: deleteNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/port-groups: + get: + tags: + - Network + summary: returns port-groups + description: returns port-groups + operationId: getNetworkVcesVcePortGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/port-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns license + description: returns license + operationId: getNetworkVcesVceLicensesLicense + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/license" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing license + description: | + Create or update an existing license. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/license" + patch: + tags: + - Network + summary: update an existing license + description: | + Update an existing license + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/license" + delete: + tags: + - Network + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/licenses: + get: + tags: + - Network + summary: returns licenses + description: returns licenses + operationId: getNetworkVcesVceLicenses + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/licenses" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns entitlement + description: returns entitlement + operationId: getNetworkVcesVceEntitlementsEntitlement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlement" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing entitlement + description: | + Create or update an existing entitlement. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/entitlement" + patch: + tags: + - Network + summary: update an existing entitlement + description: | + Update an existing entitlement + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" + delete: + tags: + - Network + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/entitlements: + get: + tags: + - Network + summary: returns entitlements + description: returns entitlements + operationId: getNetworkVcesVceEntitlements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + /network/vces/vce/{vnf-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + /network/vces/vce/{vnf-id}: + get: + tags: + - Network + summary: returns vce + description: returns vce + operationId: getNetworkVcesVce + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vce" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vce + description: | + Create or update an existing vce. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json) + required: true + schema: + $ref: "#/definitions/vce" + patch: + tags: + - Network + summary: update an existing vce + description: | + Update an existing vce + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: vce object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vce" + delete: + tags: + - Network + summary: delete an existing vce + description: delete an existing vce + operationId: deleteNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces: + get: + tags: + - Network + summary: returns vces + description: returns vces + operationId: getNetworkVces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: nfc-naming-code + in: query + description: Short code that is used in naming instances of the item being modeled + required: false + type: string + - name: nfc-function + in: query + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + required: false + type: string + - name: prov-status + in: query + description: prov status of this vnfc + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: Oam V4 vip address of this vnfc + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: group-notation + in: query + description: Group notation of VNFC + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: nfc-naming-code + in: query + description: Short code that is used in naming instances of the item being modeled + required: false + type: string + - name: nfc-function + in: query + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + required: false + type: string + - name: prov-status + in: query + description: prov status of this vnfc + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: Oam V4 vip address of this vnfc + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: group-notation + in: query + description: Group notation of VNFC + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vnfcs/vnfc/{vnfc-name}: + get: + tags: + - Network + summary: returns vnfc + description: returns vnfc + operationId: getNetworkVnfcsVnfc + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnfc" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: nfc-naming-code + in: query + description: Short code that is used in naming instances of the item being modeled + required: false + type: string + - name: nfc-function + in: query + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + required: false + type: string + - name: prov-status + in: query + description: prov status of this vnfc + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: Oam V4 vip address of this vnfc + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: group-notation + in: query + description: Group notation of VNFC + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vnfc + description: | + Create or update an existing vnfc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json) + required: true + schema: + $ref: "#/definitions/vnfc" + patch: + tags: + - Network + summary: update an existing vnfc + description: | + Update an existing vnfc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: vnfc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vnfc" + delete: + tags: + - Network + summary: delete an existing vnfc + description: delete an existing vnfc + operationId: deleteNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vnfcs: + get: + tags: + - Network + summary: returns vnfcs + description: returns vnfcs + operationId: getNetworkVnfcs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnfcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}: + get: + tags: + - Network + summary: returns host-route + description: returns host-route + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/host-route" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: subnet-name + in: query + description: Name associated with the subnet. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing host-route + description: | + Create or update an existing host-route. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) + required: true + schema: + $ref: "#/definitions/host-route" + patch: + tags: + - Network + summary: update an existing host-route + description: | + Update an existing host-route + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: host-route object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/host-route" + delete: + tags: + - Network + summary: delete an existing host-route + description: delete an existing host-route + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes: + get: + tags: + - Network + summary: returns host-routes + description: returns host-routes + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/host-routes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: subnet-name + in: query + description: Name associated with the subnet. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}: + get: + tags: + - Network + summary: returns subnet + description: returns subnet + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/subnet" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: subnet-name + in: query + description: Name associated with the subnet. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing subnet + description: | + Create or update an existing subnet. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: body + in: body + description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json) + required: true + schema: + $ref: "#/definitions/subnet" + patch: + tags: + - Network + summary: update an existing subnet + description: | + Update an existing subnet + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: body + in: body + description: subnet object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/subnet" + delete: + tags: + - Network + summary: delete an existing subnet + description: delete an existing subnet + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/subnets: + get: + tags: + - Network + summary: returns subnets + description: returns subnets + operationId: getNetworkL3NetworksL3NetworkSubnets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/subnets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}: + get: + tags: + - Network + summary: returns ctag-assignment + description: returns ctag-assignment + operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing ctag-assignment + description: | + Create or update an existing ctag-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) + required: true + schema: + $ref: "#/definitions/ctag-assignment" + patch: + tags: + - Network + summary: update an existing ctag-assignment + description: | + Update an existing ctag-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: ctag-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-assignment" + delete: + tags: + - Network + summary: delete an existing ctag-assignment + description: delete an existing ctag-assignment + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/ctag-assignments: + get: + tags: + - Network + summary: returns ctag-assignments + description: returns ctag-assignments + operationId: getNetworkL3NetworksL3NetworkCtagAssignments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-assignments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}: + get: + tags: + - Network + summary: returns segmentation-assignment + description: returns segmentation-assignment + operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/segmentation-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing segmentation-assignment + description: | + Create or update an existing segmentation-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) + required: true + schema: + $ref: "#/definitions/segmentation-assignment" + patch: + tags: + - Network + summary: update an existing segmentation-assignment + description: | + Update an existing segmentation-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/segmentation-assignment" + delete: + tags: + - Network + summary: delete an existing segmentation-assignment + description: delete an existing segmentation-assignment + operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/segmentation-assignments: + get: + tags: + - Network + summary: returns segmentation-assignments + description: returns segmentation-assignments + operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/segmentation-assignments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + /network/l3-networks/l3-network/{network-id}: + get: + tags: + - Network + summary: returns l3-network + description: returns l3-network + operationId: getNetworkL3NetworksL3Network + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-network" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-network + description: | + Create or update an existing l3-network. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: body + in: body + description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json) + required: true + schema: + $ref: "#/definitions/l3-network" + patch: + tags: + - Network + summary: update an existing l3-network + description: | + Update an existing l3-network + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: body + in: body + description: l3-network object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-network" + delete: + tags: + - Network + summary: delete an existing l3-network + description: delete an existing l3-network + operationId: deleteNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks: + get: + tags: + - Network + summary: returns l3-networks + description: returns l3-networks + operationId: getNetworkL3Networks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-networks" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + /network/network-policies/network-policy/{network-policy-id}: + get: + tags: + - Network + summary: returns network-policy + description: returns network-policy + operationId: getNetworkNetworkPoliciesNetworkPolicy + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-policy" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: network-policy-fqdn + in: query + description: Contrail FQDN for the policy + required: false + type: string + put: + tags: + - Network + summary: create or update an existing network-policy + description: | + Create or update an existing network-policy. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json) + required: true + schema: + $ref: "#/definitions/network-policy" + patch: + tags: + - Network + summary: update an existing network-policy + description: | + Update an existing network-policy + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/network-policy" + delete: + tags: + - Network + summary: delete an existing network-policy + description: delete an existing network-policy + operationId: deleteNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/network-policies: + get: + tags: + - Network + summary: returns network-policies + description: returns network-policies + operationId: getNetworkNetworkPolicies + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-policies" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkGenericVnfsGenericVnfLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: + get: + tags: + - Network + summary: returns vf-module + description: returns vf-module + operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vf-module" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: vf-module-name + in: query + description: Name of vf-module + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: contrail-service-instance-fqdn + in: query + description: the Contrail unique ID for a service-instance + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vf-module + description: | + Create or update an existing vf-module. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: body + in: body + description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) + required: true + schema: + $ref: "#/definitions/vf-module" + patch: + tags: + - Network + summary: update an existing vf-module + description: | + Update an existing vf-module + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: body + in: body + description: vf-module object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vf-module" + delete: + tags: + - Network + summary: delete an existing vf-module + description: delete an existing vf-module + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: + get: + tags: + - Network + summary: returns vf-modules + description: returns vf-modules + operationId: getNetworkGenericVnfsGenericVnfVfModules + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vf-modules" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns license + description: returns license + operationId: getNetworkGenericVnfsGenericVnfLicensesLicense + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/license" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + put: + tags: + - Network + summary: create or update an existing license + description: | + Create or update an existing license. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/license" + patch: + tags: + - Network + summary: update an existing license + description: | + Update an existing license + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/license" + delete: + tags: + - Network + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses: + get: + tags: + - Network + summary: returns licenses + description: returns licenses + operationId: getNetworkGenericVnfsGenericVnfLicenses + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/licenses" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns entitlement + description: returns entitlement + operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlement" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + put: + tags: + - Network + summary: create or update an existing entitlement + description: | + Create or update an existing entitlement. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/entitlement" + patch: + tags: + - Network + summary: update an existing entitlement + description: | + Update an existing entitlement + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" + delete: + tags: + - Network + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements: + get: + tags: + - Network + summary: returns entitlements + description: returns entitlements + operationId: getNetworkGenericVnfsGenericVnfEntitlements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}: + get: + tags: + - Network + summary: returns generic-vnf + description: returns generic-vnf + operationId: getNetworkGenericVnfsGenericVnf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/generic-vnf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + put: + tags: + - Network + summary: create or update an existing generic-vnf + description: | + Create or update an existing generic-vnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json) + required: true + schema: + $ref: "#/definitions/generic-vnf" + patch: + tags: + - Network + summary: update an existing generic-vnf + description: | + Update an existing generic-vnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/generic-vnf" + delete: + tags: + - Network + summary: delete an existing generic-vnf + description: delete an existing generic-vnf + operationId: deleteNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs: + get: + tags: + - Network + summary: returns generic-vnfs + description: returns generic-vnfs + operationId: getNetworkGenericVnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/generic-vnfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/lag-links/lag-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + /network/lag-links/lag-link/{link-name}: + get: + tags: + - Network + summary: returns lag-link + description: returns lag-link + operationId: getNetworkLagLinksLagLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + put: + tags: + - Network + summary: create or update an existing lag-link + description: | + Create or update an existing lag-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json) + required: true + schema: + $ref: "#/definitions/lag-link" + patch: + tags: + - Network + summary: update an existing lag-link + description: | + Update an existing lag-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: lag-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-link" + delete: + tags: + - Network + summary: delete an existing lag-link + description: delete an existing lag-link + operationId: deleteNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/lag-links: + get: + tags: + - Network + summary: returns lag-links + description: returns lag-links + operationId: getNetworkLagLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkNewvcesNewvceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkNewvcesNewvceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + /network/newvces/newvce/{vnf-id2}: + get: + tags: + - Network + summary: returns newvce + description: returns newvce + operationId: getNetworkNewvcesNewvce + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/newvce" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + put: + tags: + - Network + summary: create or update an existing newvce + description: | + Create or update an existing newvce. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: body + in: body + description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json) + required: true + schema: + $ref: "#/definitions/newvce" + patch: + tags: + - Network + summary: update an existing newvce + description: | + Update an existing newvce + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: body + in: body + description: newvce object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/newvce" + delete: + tags: + - Network + summary: delete an existing newvce + description: delete an existing newvce + operationId: deleteNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces: + get: + tags: + - Network + summary: returns newvces + description: returns newvces + operationId: getNetworkNewvces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/newvces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - Network + summary: returns sriov-pf + description: returns sriov-pf + operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - Network + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - Network + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - Network + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: + get: + tags: + - Network + summary: returns p-interface + description: returns p-interface + operationId: getNetworkPnfsPnfPInterfacesPInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - Network + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" + delete: + tags: + - Network + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteNetworkPnfsPnfPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces: + get: + tags: + - Network + summary: returns p-interfaces + description: returns p-interfaces + operationId: getNetworkPnfsPnfPInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkPnfsPnfLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkPnfsPnfLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + /network/pnfs/pnf/{pnf-name}: + get: + tags: + - Network + summary: returns pnf + description: returns pnf + operationId: getNetworkPnfsPnf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pnf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing pnf + description: | + Create or update an existing pnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json) + required: true + schema: + $ref: "#/definitions/pnf" + patch: + tags: + - Network + summary: update an existing pnf + description: | + Update an existing pnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: pnf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/pnf" + delete: + tags: + - Network + summary: delete an existing pnf + description: delete an existing pnf + operationId: deleteNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs: + get: + tags: + - Network + summary: returns pnfs + description: returns pnfs + operationId: getNetworkPnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pnfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/physical-links/physical-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + /network/physical-links/physical-link/{link-name}: + get: + tags: + - Network + summary: returns physical-link + description: returns physical-link + operationId: getNetworkPhysicalLinksPhysicalLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/physical-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: circuit-id + in: query + description: Circuit it + required: false + type: string + put: + tags: + - Network + summary: create or update an existing physical-link + description: | + Create or update an existing physical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json) + required: true + schema: + $ref: "#/definitions/physical-link" + patch: + tags: + - Network + summary: update an existing physical-link + description: | + Update an existing physical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: physical-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/physical-link" + delete: + tags: + - Network + summary: delete an existing physical-link + description: delete an existing physical-link + operationId: deleteNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/physical-links: + get: + tags: + - Network + summary: returns physical-links + description: returns physical-links + operationId: getNetworkPhysicalLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/physical-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}: + get: + tags: + - Network + summary: returns vig-server + description: returns vig-server + operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vig-server" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + put: + tags: + - Network + summary: create or update an existing vig-server + description: | + Create or update an existing vig-server. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) + required: true + schema: + $ref: "#/definitions/vig-server" + patch: + tags: + - Network + summary: update an existing vig-server + description: | + Update an existing vig-server + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: vig-server object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vig-server" + delete: + tags: + - Network + summary: delete an existing vig-server + description: delete an existing vig-server + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers: + get: + tags: + - Network + summary: returns vig-servers + description: returns vig-servers + operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vig-servers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: + get: + tags: + - Network + summary: returns ipsec-configuration + description: returns ipsec-configuration + operationId: getNetworkIpsecConfigurationsIpsecConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ipsec-configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + put: + tags: + - Network + summary: create or update an existing ipsec-configuration + description: | + Create or update an existing ipsec-configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json) + required: true + schema: + $ref: "#/definitions/ipsec-configuration" + patch: + tags: + - Network + summary: update an existing ipsec-configuration + description: | + Update an existing ipsec-configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: ipsec-configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ipsec-configuration" + delete: + tags: + - Network + summary: delete an existing ipsec-configuration + description: delete an existing ipsec-configuration + operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/ipsec-configurations: + get: + tags: + - Network + summary: returns ipsec-configurations + description: returns ipsec-configurations + operationId: getNetworkIpsecConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ipsec-configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + /network/route-table-references/route-table-reference/{route-table-reference-id}: + get: + tags: + - Network + summary: returns route-table-reference + description: returns route-table-reference + operationId: getNetworkRouteTableReferencesRouteTableReference + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-table-reference" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: route-table-reference-fqdn + in: query + description: FQDN entry in the route table. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing route-table-reference + description: | + Create or update an existing route-table-reference. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json) + required: true + schema: + $ref: "#/definitions/route-table-reference" + patch: + tags: + - Network + summary: update an existing route-table-reference + description: | + Update an existing route-table-reference + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: route-table-reference object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/route-table-reference" + delete: + tags: + - Network + summary: delete an existing route-table-reference + description: delete an existing route-table-reference + operationId: deleteNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/route-table-references: + get: + tags: + - Network + summary: returns route-table-references + description: returns route-table-references + operationId: getNetworkRouteTableReferences + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-table-references" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/instance-groups/instance-group/{id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + /network/instance-groups/instance-group/{id}: + get: + tags: + - Network + summary: returns instance-group + description: returns instance-group + operationId: getNetworkInstanceGroupsInstanceGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/instance-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: description + in: query + description: Descriptive text to help identify the usage of this instance-group + required: false + type: string + - name: type + in: query + description: Only valid value today is lower case ha for high availability + required: false + type: string + - name: sub-type + in: query + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + required: false + type: string + put: + tags: + - Network + summary: create or update an existing instance-group + description: | + Create or update an existing instance-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json) + required: true + schema: + $ref: "#/definitions/instance-group" + patch: + tags: + - Network + summary: update an existing instance-group + description: | + Update an existing instance-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: instance-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/instance-group" + delete: + tags: + - Network + summary: delete an existing instance-group + description: delete an existing instance-group + operationId: deleteNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/instance-groups: + get: + tags: + - Network + summary: returns instance-groups + description: returns instance-groups + operationId: getNetworkInstanceGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/instance-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/zones/zone/{zone-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkZonesZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + /network/zones/zone/{zone-id}: + get: + tags: + - Network + summary: returns zone + description: returns zone + operationId: getNetworkZonesZone + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/zone" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: design-type + in: query + description: Design of zone [Medium/Largeā€¦] + required: false + type: string + - name: zone-context + in: query + description: Context of zone [production/test] + required: false + type: string + put: + tags: + - Network + summary: create or update an existing zone + description: | + Create or update an existing zone. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json) + required: true + schema: + $ref: "#/definitions/zone" + patch: + tags: + - Network + summary: update an existing zone + description: | + Update an existing zone + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: zone object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/zone" + delete: + tags: + - Network + summary: delete an existing zone + description: delete an existing zone + operationId: deleteNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/zones: + get: + tags: + - Network + summary: returns zones + description: returns zones + operationId: getNetworkZones + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/zones" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/configurations/configuration/{configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}: + get: + tags: + - Network + summary: returns metadatum + description: returns metadatum + operationId: getNetworkConfigurationsConfigurationMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Network + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Network + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/metadata: + get: + tags: + - Network + summary: returns metadata + description: returns metadata + operationId: getNetworkConfigurationsConfigurationMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}: + get: + tags: + - Network + summary: returns forwarder-evc + description: returns forwarder-evc + operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarder-evc" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing forwarder-evc + description: | + Create or update an existing forwarder-evc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: body + in: body + description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) + required: true + schema: + $ref: "#/definitions/forwarder-evc" + patch: + tags: + - Network + summary: update an existing forwarder-evc + description: | + Update an existing forwarder-evc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: body + in: body + description: forwarder-evc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/forwarder-evc" + delete: + tags: + - Network + summary: delete an existing forwarder-evc + description: delete an existing forwarder-evc + operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/forwarder-evcs: + get: + tags: + - Network + summary: returns forwarder-evcs + description: returns forwarder-evcs + operationId: getNetworkConfigurationsConfigurationForwarderEvcs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarder-evcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}: + get: + tags: + - Network + summary: returns evc + description: returns evc + operationId: getNetworkConfigurationsConfigurationEvcsEvc + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/evc" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing evc + description: | + Create or update an existing evc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: body + in: body + description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json) + required: true + schema: + $ref: "#/definitions/evc" + patch: + tags: + - Network + summary: update an existing evc + description: | + Update an existing evc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: body + in: body + description: evc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/evc" + delete: + tags: + - Network + summary: delete an existing evc + description: delete an existing evc + operationId: deleteNetworkConfigurationsConfigurationEvcsEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/evcs: + get: + tags: + - Network + summary: returns evcs + description: returns evcs + operationId: getNetworkConfigurationsConfigurationEvcs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/evcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + /network/configurations/configuration/{configuration-id}: + get: + tags: + - Network + summary: returns configuration + description: returns configuration + operationId: getNetworkConfigurationsConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing configuration + description: | + Create or update an existing configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json) + required: true + schema: + $ref: "#/definitions/configuration" + patch: + tags: + - Network + summary: update an existing configuration + description: | + Update an existing configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/configuration" + delete: + tags: + - Network + summary: delete an existing configuration + description: delete an existing configuration + operationId: deleteNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations: + get: + tags: + - Network + summary: returns configurations + description: returns configurations + operationId: getNetworkConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}: + get: + tags: + - Network + summary: returns forwarder + description: returns forwarder + operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarder" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: forwarding-path-name + in: query + description: Name of the FP + required: false + type: string + put: + tags: + - Network + summary: create or update an existing forwarder + description: | + Create or update an existing forwarder. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: body + in: body + description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json) + required: true + schema: + $ref: "#/definitions/forwarder" + patch: + tags: + - Network + summary: update an existing forwarder + description: | + Update an existing forwarder + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: body + in: body + description: forwarder object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/forwarder" + delete: + tags: + - Network + summary: delete an existing forwarder + description: delete an existing forwarder + operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders: + get: + tags: + - Network + summary: returns forwarders + description: returns forwarders + operationId: getNetworkForwardingPathsForwardingPathForwarders + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarders" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: forwarding-path-name + in: query + description: Name of the FP + required: false + type: string + /network/forwarding-paths/forwarding-path/{forwarding-path-id}: + get: + tags: + - Network + summary: returns forwarding-path + description: returns forwarding-path + operationId: getNetworkForwardingPathsForwardingPath + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarding-path" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: forwarding-path-name + in: query + description: Name of the FP + required: false + type: string + put: + tags: + - Network + summary: create or update an existing forwarding-path + description: | + Create or update an existing forwarding-path. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkForwardingPathsForwardingPath + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: body + in: body + description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json) + required: true + schema: + $ref: "#/definitions/forwarding-path" + patch: + tags: + - Network + summary: update an existing forwarding-path + description: | + Update an existing forwarding-path + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkForwardingPathsForwardingPath + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: body + in: body + description: forwarding-path object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/forwarding-path" + delete: + tags: + - Network + summary: delete an existing forwarding-path + description: delete an existing forwarding-path + operationId: deleteNetworkForwardingPathsForwardingPath + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/forwarding-paths: + get: + tags: + - Network + summary: returns forwarding-paths + description: returns forwarding-paths + operationId: getNetworkForwardingPaths + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarding-paths" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). +definitions: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/definitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/definitions/update" + notify: + type: object + $ref: "#/definitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Concurrency value + orchestration-status: + type: string + description: Orchestration status + operational-status: + type: string + description: Indicator for whether the resource is considered operational + type: + type: string + description: Generic description of the type of allotted resource. + role: + type: string + description: role in the network that this resource will be providing. + tunnel-xconnects: + type: array + items: + $ref: "#/definitions/tunnel-xconnect" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/definitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/definitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/definitions/dvs-switches" + availability-zone: + type: object + $ref: "#/definitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/definitions/connector" + customers: + type: array + items: + $ref: "#/definitions/customer" + lines-of-business: + type: array + items: + $ref: "#/definitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/definitions/owning-entity" + platforms: + type: array + items: + $ref: "#/definitions/platform" + projects: + type: array + items: + $ref: "#/definitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/definitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/definitions/complex" + cloud-regions: + type: array + items: + $ref: "#/definitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/definitions/network-profile" + pservers: + type: array + items: + $ref: "#/definitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/definitions/virtual-data-center" + operational-environments: + type: array + items: + $ref: "#/definitions/operational-environment" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. + ###### Related Nodes + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volume-groups: + type: array + items: + $ref: "#/definitions/volume-group" + tenants: + type: array + items: + $ref: "#/definitions/tenant" + flavors: + type: array + items: + $ref: "#/definitions/flavor" + group-assignments: + type: array + items: + $ref: "#/definitions/group-assignment" + snapshots: + type: array + items: + $ref: "#/definitions/snapshot" + images: + type: array + items: + $ref: "#/definitions/image" + dvs-switches: + type: array + items: + $ref: "#/definitions/dvs-switch" + oam-networks: + type: array + items: + $ref: "#/definitions/oam-network" + availability-zones: + type: array + items: + $ref: "#/definitions/availability-zone" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vip-ipv4-address-list: + type: array + items: + $ref: "#/definitions/vip-ipv4-address-list" + vip-ipv6-address-list: + type: array + items: + $ref: "#/definitions/vip-ipv6-address-list" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/definitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + physical-location-type: + type: string + description: Type, e.g., central office, data center. + street1: + type: string + street2: + type: string + city: + type: string + state: + type: string + postal-code: + type: string + country: + type: string + region: + type: string + latitude: + type: string + longitude: + type: string + elevation: + type: string + lata: + type: string + ctag-pools: + type: array + items: + $ref: "#/definitions/ctag-pool" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/definitions/complex" + configuration: + description: | + Port Mirror Configuration. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + required: + - configuration-id + - configuration-type + - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + tunnel-bandwidth: + type: string + description: DHV Site Effective Bandwidth + vendor-allowed-max-bandwidth: + type: string + description: Velocloud Nominal Throughput - VNT + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + forwarder-evcs: + type: array + items: + $ref: "#/definitions/forwarder-evc" + evcs: + type: array + items: + $ref: "#/definitions/evc" + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/definitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/definitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + resource-version: + type: string + element-choice-sets: + type: array + items: + $ref: "#/definitions/element-choice-set" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/definitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/definitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/definitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-subscriptions: + type: array + items: + $ref: "#/definitions/service-subscription" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/definitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/definitions/cvlan-tag-entry" + dvs-switch: + description: | + Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. + ###### Related Nodes + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/definitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + aai-uuid: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/definitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/definitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/definitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + resource-version: + type: string + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/definitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/definitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/definitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/definitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/definitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/definitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + evcs: + properties: + evc: + type: array + items: + $ref: "#/definitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/definitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/definitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/definitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/definitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/definitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/definitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/definitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: the self link for this FP + forwarders: + type: array + items: + $ref: "#/definitions/forwarder" + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/definitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - vnf-id + - vnf-instance-id + - vnf-name + - vnf-type + - vnf-package-name + - vnf-discriptor-name + - job-id + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + summary-status: + type: string + description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether generic-vnf access uses SSH + entitlement-assignment-group-uuid: + type: string + description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. + entitlement-resource-uuid: + type: string + description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. + license-assignment-group-uuid: + type: string + description: UUID of the license assignment group. OBSOLETE - See child relationships. + license-key-uuid: + type: string + description: UUID of the actual license resource. OBSOLETE - See child relationships. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + as-number: + type: string + description: as-number of the VNF + regional-resource-subzone: + type: string + description: represents sub zone of the rr plane + nf-type: + type: string + description: Generic description of the type of NF + nf-function: + type: string + description: English description of Network function that the specific VNF deployment is providing + nf-role: + type: string + description: role in the network that this model will be providing + nf-naming-code: + type: string + description: string assigned to this model used for naming purposes + selflink: + type: string + description: Path to the controller object. + ipv4-oam-gateway-address: + type: string + description: Gateway address + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for S-TAG to get to VCE + nm-profile-name: + type: string + description: Network Management profile of this VNF + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + vf-modules: + type: array + items: + $ref: "#/definitions/vf-module" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/definitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/definitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/definitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/definitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/definitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - instance-group-role + - model-invariant-id + - model-version-id + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/definitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/definitions/search" + actions: + type: object + $ref: "#/definitions/actions" + cloud-infrastructure: + type: object + $ref: "#/definitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/definitions/external-system" + business: + type: object + $ref: "#/definitions/business" + service-design-and-creation: + type: object + $ref: "#/definitions/service-design-and-creation" + network: + type: object + $ref: "#/definitions/network" + aai-internal: + type: object + $ref: "#/definitions/aai-internal" + nodes: + type: array + items: + $ref: "#/definitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/definitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/definitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/definitions/inventory-response-item" + ipsec-configuration: + description: | + IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vig-servers: + type: array + items: + $ref: "#/definitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/definitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + allowed-address-pairs: + type: string + description: Freeform field for storing an ip address, list of ip addresses or a subnet block. + vlans: + type: array + items: + $ref: "#/definitions/vlan" + sriov-vfs: + type: array + items: + $ref: "#/definitions/sriov-vf" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/definitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + contrail-network-fqdn: + type: string + description: Contrail FQDN for the network + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + physical-network-name: + type: string + description: Name associated with the physical network. + is-provider-network: + type: boolean + is-shared-network: + type: boolean + is-external-network: + type: boolean + selflink: + type: string + description: Path to the controller object. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + subnets: + type: array + items: + $ref: "#/definitions/subnet" + ctag-assignments: + type: array + items: + $ref: "#/definitions/ctag-assignment" + segmentation-assignments: + type: array + items: + $ref: "#/definitions/segmentation-assignment" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/definitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + interface-id: + type: string + description: ID of interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + in-maint: + type: boolean + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/definitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/definitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/definitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/definitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + operational-status: + type: string + description: Indication of operational status of the logical link. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: + type: string + description: Indication of the network use of the logical link. + link-name2: + type: string + description: Alias or alternate name (CLCI or D1 name). + link-id: + type: string + description: UUID of the logical-link, SDNC generates this. + circuit-id: + type: string + description: Circuit id + purpose: + type: string + description: Reason for this entity, role it is playing + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/definitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/definitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: array + items: + $ref: "#/definitions/model-ver" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/definitions/query-parameters" + instance-filters: + type: object + $ref: "#/definitions/instance-filters" + secondary-filts: + type: object + $ref: "#/definitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/definitions/constrained-element-set" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/definitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + description: Defines how other models combine to make up a higher-level model + model-constraints: + type: array + items: + $ref: "#/definitions/model-constraint" + description: Describes new constraints on this model element that are not part of that model's definition + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/definitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + distribution-status: + type: string + description: Distribution Status + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/definitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/definitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/definitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/definitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + resource-version: + type: string + named-query-elements: + type: array + items: + $ref: "#/definitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + resource-version: + type: string + property-limit-desc: + type: string + do-not-output: + type: string + named-query-elements: + type: array + items: + $ref: "#/definitions/named-query-element" + related-lookups: + type: array + items: + $ref: "#/definitions/related-lookup" + property-constraints: + type: array + items: + $ref: "#/definitions/property-constraint" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/definitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/definitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/definitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/definitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/definitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/definitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/definitions/vce" + vnfcs: + type: array + items: + $ref: "#/definitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/definitions/l3-network" + network-policies: + type: array + items: + $ref: "#/definitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/definitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/definitions/lag-link" + newvces: + type: array + items: + $ref: "#/definitions/newvce" + pnfs: + type: array + items: + $ref: "#/definitions/pnf" + physical-links: + type: array + items: + $ref: "#/definitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/definitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/definitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/definitions/instance-group" + zones: + type: array + items: + $ref: "#/definitions/zone" + configurations: + type: array + items: + $ref: "#/definitions/configuration" + forwarding-paths: + type: array + items: + $ref: "#/definitions/forwarding-path" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/definitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/definitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO. + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/definitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/definitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/definitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/definitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/definitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: object + $ref: "#/definitions/model-vers" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/definitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + selflink: + type: string + description: URL to endpoint where AAI can get more details. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + inv-status: + type: string + description: inventory status + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-pfs: + type: array + items: + $ref: "#/definitions/sriov-pf" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/definitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/definitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/definitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + selflink: + type: string + description: URL to endpoint where AAI can get more details. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + nf-role: + type: string + description: Nf Role is the role performed by this instance in the network. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/definitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + port-group-id: + type: string + description: Unique ID for port group in vmware + port-group-name: + type: string + description: Likely to duplicate value of neutron network name + switch-name: + type: string + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + cvlan-tags: + type: array + items: + $ref: "#/definitions/cvlan-tag-entry" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/definitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/definitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + resource-version: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/definitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + pserver-name2: + type: string + description: alternative pserver name + purpose: + type: string + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + management-option: + type: string + description: Indicates who owns and or manages the device. + host-profile: + type: string + description: The host profile that defines the configuration of the pserver. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/definitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/definitions/named-query" + overloaded-model: + type: object + $ref: "#/definitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + resource-version: + type: string + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/definitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + relationship-label: + type: string + description: The edge label for this relationship. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/definitions/relationship-data" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/definitions/relationship" + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/definitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/definitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/definitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + site-pairs: + type: array + items: + $ref: "#/definitions/site-pair" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/definitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/definitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/definitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/definitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/definitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/definitions/search-results" + sdn-zone-response: + type: object + $ref: "#/definitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/definitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/definitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/definitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-version: + type: string + description: service version + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/definitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/definitions/vnf-image" + services: + type: array + items: + $ref: "#/definitions/service" + service-capabilities: + type: array + items: + $ref: "#/definitions/service-capability" + models: + type: array + items: + $ref: "#/definitions/model" + named-queries: + type: array + items: + $ref: "#/definitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + - service-type + - service-role + - created-at + - updated-at + - description + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: Path to the controller object. + orchestration-status: + type: string + description: Orchestration status of this service. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + allotted-resources: + type: array + items: + $ref: "#/definitions/allotted-resource" + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/definitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-instances: + type: array + items: + $ref: "#/definitions/service-instance" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/definitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/definitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + classes-of-service: + type: array + items: + $ref: "#/definitions/class-of-service" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + routing-instances: + type: array + items: + $ref: "#/definitions/routing-instance" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/definitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/definitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/definitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/definitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mac-anti-spoof-check: + type: boolean + description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/definitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + - SUBNET is DELETED when these are DELETED HOST-ROUTE + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + subnet-sequence: + type: integer + format: int32 + description: sequence of the subnet + host-routes: + type: array + items: + $ref: "#/definitions/host-route" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/definitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/definitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vservers: + type: array + items: + $ref: "#/definitions/vserver" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/definitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/definitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/definitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/definitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: Loopback0 address + entitlement-resource-uuid: + type: string + description: OBSOLETE - see child relationships + port-groups: + type: array + items: + $ref: "#/definitions/port-group" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/definitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - VF-MODULE cannot be deleted if linked to VNFC + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + contrail-service-instance-fqdn: + type: string + description: the Contrail unique ID for a service-instance + module-index: + type: integer + format: int32 + description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit + selflink: + type: string + description: Path to the controller object. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/definitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/definitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/definitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + vlan-description: + type: string + description: Used to describe (the service associated with) the vlan + backdoor-connection: + type: string + description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. + vpn-key: + type: string + description: This indicates the customers VPN ID associated with this vlan + orchestration-status: + type: string + description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + vlans: + properties: + vlan: + type: array + items: + $ref: "#/definitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/definitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/definitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/definitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/definitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/definitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + route-targets: + type: array + items: + $ref: "#/definitions/route-target" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/definitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volumes: + type: array + items: + $ref: "#/definitions/volume" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/definitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Largeā€¦] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/definitions/zone" +patchDefinitions: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/patchDefinitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/patchDefinitions/update" + notify: + type: object + $ref: "#/patchDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/patchDefinitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/patchDefinitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/patchDefinitions/dvs-switches" + availability-zone: + type: object + $ref: "#/patchDefinitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/patchDefinitions/connector" + customers: + type: array + items: + $ref: "#/patchDefinitions/customer" + lines-of-business: + type: array + items: + $ref: "#/patchDefinitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/patchDefinitions/owning-entity" + platforms: + type: array + items: + $ref: "#/patchDefinitions/platform" + projects: + type: array + items: + $ref: "#/patchDefinitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/patchDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/patchDefinitions/complex" + cloud-regions: + type: array + items: + $ref: "#/patchDefinitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/patchDefinitions/network-profile" + pservers: + type: array + items: + $ref: "#/patchDefinitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/patchDefinitions/virtual-data-center" + operational-environments: + type: array + items: + $ref: "#/patchDefinitions/operational-environment" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. + ###### Related Nodes + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/patchDefinitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/patchDefinitions/complex" + configuration: + description: | + Port Mirror Configuration. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + required: + - configuration-id + - configuration-type + - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + tunnel-bandwidth: + type: string + description: DHV Site Effective Bandwidth + vendor-allowed-max-bandwidth: + type: string + description: Velocloud Nominal Throughput - VNT + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/patchDefinitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/patchDefinitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/patchDefinitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/patchDefinitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/patchDefinitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/patchDefinitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/patchDefinitions/cvlan-tag-entry" + dvs-switch: + description: | + Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. + ###### Related Nodes + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/patchDefinitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + aai-uuid: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/patchDefinitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/patchDefinitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/patchDefinitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/patchDefinitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/patchDefinitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/patchDefinitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/patchDefinitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/patchDefinitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/patchDefinitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/patchDefinitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + evcs: + properties: + evc: + type: array + items: + $ref: "#/patchDefinitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/patchDefinitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/patchDefinitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/patchDefinitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/patchDefinitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/patchDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/patchDefinitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/patchDefinitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - vnf-id + - vnf-instance-id + - vnf-name + - vnf-type + - vnf-package-name + - vnf-discriptor-name + - job-id + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/patchDefinitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/patchDefinitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/patchDefinitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/patchDefinitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/patchDefinitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - instance-group-role + - model-invariant-id + - model-version-id + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/patchDefinitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/patchDefinitions/search" + actions: + type: object + $ref: "#/patchDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/patchDefinitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/patchDefinitions/external-system" + business: + type: object + $ref: "#/patchDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/patchDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/patchDefinitions/network" + aai-internal: + type: object + $ref: "#/patchDefinitions/aai-internal" + nodes: + type: array + items: + $ref: "#/patchDefinitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/patchDefinitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/patchDefinitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/patchDefinitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/patchDefinitions/inventory-response-item" + ipsec-configuration: + description: | + IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/patchDefinitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/patchDefinitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/patchDefinitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/patchDefinitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/patchDefinitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/patchDefinitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/patchDefinitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/patchDefinitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/patchDefinitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/patchDefinitions/query-parameters" + instance-filters: + type: object + $ref: "#/patchDefinitions/instance-filters" + secondary-filts: + type: object + $ref: "#/patchDefinitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/patchDefinitions/constrained-element-set" + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/patchDefinitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/patchDefinitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + distribution-status: + type: string + description: Distribution Status + model-description: + type: string + description: Description + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/patchDefinitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/patchDefinitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/patchDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/patchDefinitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/patchDefinitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/patchDefinitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/patchDefinitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/patchDefinitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/patchDefinitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/patchDefinitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/patchDefinitions/vce" + vnfcs: + type: array + items: + $ref: "#/patchDefinitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/patchDefinitions/l3-network" + network-policies: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/patchDefinitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/patchDefinitions/lag-link" + newvces: + type: array + items: + $ref: "#/patchDefinitions/newvce" + pnfs: + type: array + items: + $ref: "#/patchDefinitions/pnf" + physical-links: + type: array + items: + $ref: "#/patchDefinitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/patchDefinitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/patchDefinitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/patchDefinitions/instance-group" + zones: + type: array + items: + $ref: "#/patchDefinitions/zone" + configurations: + type: array + items: + $ref: "#/patchDefinitions/configuration" + forwarding-paths: + type: array + items: + $ref: "#/patchDefinitions/forwarding-path" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/patchDefinitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value. + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/patchDefinitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/patchDefinitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/patchDefinitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/patchDefinitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/patchDefinitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/patchDefinitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + selflink: + type: string + description: URL to endpoint where AAI can get more details. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/patchDefinitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/patchDefinitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/patchDefinitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + selflink: + type: string + description: URL to endpoint where AAI can get more details. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/patchDefinitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/patchDefinitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/patchDefinitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/patchDefinitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/patchDefinitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/patchDefinitions/named-query" + overloaded-model: + type: object + $ref: "#/patchDefinitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/patchDefinitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + relationship-label: + type: string + description: The edge label for this relationship. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/patchDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/patchDefinitions/related-to-property" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/patchDefinitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/patchDefinitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/patchDefinitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/patchDefinitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/patchDefinitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/patchDefinitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/patchDefinitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/patchDefinitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/patchDefinitions/search-results" + sdn-zone-response: + type: object + $ref: "#/patchDefinitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/patchDefinitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/patchDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/patchDefinitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/patchDefinitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/patchDefinitions/vnf-image" + services: + type: array + items: + $ref: "#/patchDefinitions/service" + service-capabilities: + type: array + items: + $ref: "#/patchDefinitions/service-capability" + models: + type: array + items: + $ref: "#/patchDefinitions/model" + named-queries: + type: array + items: + $ref: "#/patchDefinitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + - service-type + - service-role + - created-at + - updated-at + - description + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/patchDefinitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/patchDefinitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/patchDefinitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/patchDefinitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/patchDefinitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/patchDefinitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/patchDefinitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mac-anti-spoof-check: + type: boolean + description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/patchDefinitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + - SUBNET is DELETED when these are DELETED HOST-ROUTE + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + subnets: + properties: + subnet: + type: array + items: + $ref: "#/patchDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/patchDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/patchDefinitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/patchDefinitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/patchDefinitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/patchDefinitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/patchDefinitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - VF-MODULE cannot be deleted if linked to VNFC + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/patchDefinitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/patchDefinitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/patchDefinitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + vlans: + properties: + vlan: + type: array + items: + $ref: "#/patchDefinitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/patchDefinitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/patchDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/patchDefinitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/patchDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/patchDefinitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/patchDefinitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/patchDefinitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Largeā€¦] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/patchDefinitions/zone" +getDefinitions: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/getDefinitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/getDefinitions/update" + notify: + type: object + $ref: "#/getDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Concurrency value + orchestration-status: + type: string + description: Orchestration status + operational-status: + type: string + description: Indicator for whether the resource is considered operational + type: + type: string + description: Generic description of the type of allotted resource. + role: + type: string + description: role in the network that this resource will be providing. + tunnel-xconnects: + type: array + items: + $ref: "#/getDefinitions/tunnel-xconnect" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/getDefinitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/getDefinitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/getDefinitions/dvs-switches" + availability-zone: + type: object + $ref: "#/getDefinitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/getDefinitions/connector" + customers: + type: array + items: + $ref: "#/getDefinitions/customer" + lines-of-business: + type: array + items: + $ref: "#/getDefinitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/getDefinitions/owning-entity" + platforms: + type: array + items: + $ref: "#/getDefinitions/platform" + projects: + type: array + items: + $ref: "#/getDefinitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/getDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/getDefinitions/complex" + cloud-regions: + type: array + items: + $ref: "#/getDefinitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/getDefinitions/network-profile" + pservers: + type: array + items: + $ref: "#/getDefinitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/getDefinitions/virtual-data-center" + operational-environments: + type: array + items: + $ref: "#/getDefinitions/operational-environment" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. + ###### Related Nodes + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volume-groups: + type: array + items: + $ref: "#/getDefinitions/volume-group" + tenants: + type: array + items: + $ref: "#/getDefinitions/tenant" + flavors: + type: array + items: + $ref: "#/getDefinitions/flavor" + group-assignments: + type: array + items: + $ref: "#/getDefinitions/group-assignment" + snapshots: + type: array + items: + $ref: "#/getDefinitions/snapshot" + images: + type: array + items: + $ref: "#/getDefinitions/image" + dvs-switches: + type: array + items: + $ref: "#/getDefinitions/dvs-switch" + oam-networks: + type: array + items: + $ref: "#/getDefinitions/oam-network" + availability-zones: + type: array + items: + $ref: "#/getDefinitions/availability-zone" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vip-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/vip-ipv4-address-list" + vip-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/vip-ipv6-address-list" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/getDefinitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + physical-location-type: + type: string + description: Type, e.g., central office, data center. + street1: + type: string + street2: + type: string + city: + type: string + state: + type: string + postal-code: + type: string + country: + type: string + region: + type: string + latitude: + type: string + longitude: + type: string + elevation: + type: string + lata: + type: string + ctag-pools: + type: array + items: + $ref: "#/getDefinitions/ctag-pool" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/getDefinitions/complex" + configuration: + description: | + Port Mirror Configuration. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + required: + - configuration-id + - configuration-type + - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + tunnel-bandwidth: + type: string + description: DHV Site Effective Bandwidth + vendor-allowed-max-bandwidth: + type: string + description: Velocloud Nominal Throughput - VNT + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + forwarder-evcs: + type: array + items: + $ref: "#/getDefinitions/forwarder-evc" + evcs: + type: array + items: + $ref: "#/getDefinitions/evc" + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/getDefinitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/getDefinitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + resource-version: + type: string + element-choice-sets: + type: array + items: + $ref: "#/getDefinitions/element-choice-set" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/getDefinitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/getDefinitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/getDefinitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-subscriptions: + type: array + items: + $ref: "#/getDefinitions/service-subscription" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/getDefinitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/getDefinitions/cvlan-tag-entry" + dvs-switch: + description: | + Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. + ###### Related Nodes + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/getDefinitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + aai-uuid: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/getDefinitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/getDefinitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/getDefinitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/getDefinitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + resource-version: + type: string + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/getDefinitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/getDefinitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/getDefinitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/getDefinitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/getDefinitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/getDefinitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + evcs: + properties: + evc: + type: array + items: + $ref: "#/getDefinitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/getDefinitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/getDefinitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/getDefinitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/getDefinitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/getDefinitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/getDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/getDefinitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: the self link for this FP + forwarders: + type: array + items: + $ref: "#/getDefinitions/forwarder" + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/getDefinitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - vnf-id + - vnf-instance-id + - vnf-name + - vnf-type + - vnf-package-name + - vnf-discriptor-name + - job-id + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + summary-status: + type: string + description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether generic-vnf access uses SSH + entitlement-assignment-group-uuid: + type: string + description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. + entitlement-resource-uuid: + type: string + description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. + license-assignment-group-uuid: + type: string + description: UUID of the license assignment group. OBSOLETE - See child relationships. + license-key-uuid: + type: string + description: UUID of the actual license resource. OBSOLETE - See child relationships. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + as-number: + type: string + description: as-number of the VNF + regional-resource-subzone: + type: string + description: represents sub zone of the rr plane + nf-type: + type: string + description: Generic description of the type of NF + nf-function: + type: string + description: English description of Network function that the specific VNF deployment is providing + nf-role: + type: string + description: role in the network that this model will be providing + nf-naming-code: + type: string + description: string assigned to this model used for naming purposes + selflink: + type: string + description: Path to the controller object. + ipv4-oam-gateway-address: + type: string + description: Gateway address + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for S-TAG to get to VCE + nm-profile-name: + type: string + description: Network Management profile of this VNF + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + vf-modules: + type: array + items: + $ref: "#/getDefinitions/vf-module" + licenses: + type: array + items: + $ref: "#/getDefinitions/license" + entitlements: + type: array + items: + $ref: "#/getDefinitions/entitlement" + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/getDefinitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/getDefinitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/getDefinitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/getDefinitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/getDefinitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - instance-group-role + - model-invariant-id + - model-version-id + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/getDefinitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/getDefinitions/search" + actions: + type: object + $ref: "#/getDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/getDefinitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/getDefinitions/external-system" + business: + type: object + $ref: "#/getDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/getDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/getDefinitions/network" + aai-internal: + type: object + $ref: "#/getDefinitions/aai-internal" + nodes: + type: array + items: + $ref: "#/getDefinitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/getDefinitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/getDefinitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/getDefinitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/getDefinitions/inventory-response-item" + ipsec-configuration: + description: | + IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vig-servers: + type: array + items: + $ref: "#/getDefinitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/getDefinitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + allowed-address-pairs: + type: string + description: Freeform field for storing an ip address, list of ip addresses or a subnet block. + vlans: + type: array + items: + $ref: "#/getDefinitions/vlan" + sriov-vfs: + type: array + items: + $ref: "#/getDefinitions/sriov-vf" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/getDefinitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + contrail-network-fqdn: + type: string + description: Contrail FQDN for the network + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + physical-network-name: + type: string + description: Name associated with the physical network. + is-provider-network: + type: boolean + is-shared-network: + type: boolean + is-external-network: + type: boolean + selflink: + type: string + description: Path to the controller object. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + subnets: + type: array + items: + $ref: "#/getDefinitions/subnet" + ctag-assignments: + type: array + items: + $ref: "#/getDefinitions/ctag-assignment" + segmentation-assignments: + type: array + items: + $ref: "#/getDefinitions/segmentation-assignment" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/getDefinitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + interface-id: + type: string + description: ID of interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + in-maint: + type: boolean + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/getDefinitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/getDefinitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/getDefinitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + operational-status: + type: string + description: Indication of operational status of the logical link. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: + type: string + description: Indication of the network use of the logical link. + link-name2: + type: string + description: Alias or alternate name (CLCI or D1 name). + link-id: + type: string + description: UUID of the logical-link, SDNC generates this. + circuit-id: + type: string + description: Circuit id + purpose: + type: string + description: Reason for this entity, role it is playing + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/getDefinitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/getDefinitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: array + items: + $ref: "#/getDefinitions/model-ver" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/getDefinitions/query-parameters" + instance-filters: + type: object + $ref: "#/getDefinitions/instance-filters" + secondary-filts: + type: object + $ref: "#/getDefinitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/getDefinitions/constrained-element-set" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/getDefinitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + description: Defines how other models combine to make up a higher-level model + model-constraints: + type: array + items: + $ref: "#/getDefinitions/model-constraint" + description: Describes new constraints on this model element that are not part of that model's definition + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/getDefinitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + distribution-status: + type: string + description: Distribution Status + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/getDefinitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/getDefinitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/getDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/getDefinitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + resource-version: + type: string + named-query-elements: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + resource-version: + type: string + property-limit-desc: + type: string + do-not-output: + type: string + named-query-elements: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + related-lookups: + type: array + items: + $ref: "#/getDefinitions/related-lookup" + property-constraints: + type: array + items: + $ref: "#/getDefinitions/property-constraint" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/getDefinitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/getDefinitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/getDefinitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/getDefinitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/getDefinitions/vce" + vnfcs: + type: array + items: + $ref: "#/getDefinitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/getDefinitions/l3-network" + network-policies: + type: array + items: + $ref: "#/getDefinitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/getDefinitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/getDefinitions/lag-link" + newvces: + type: array + items: + $ref: "#/getDefinitions/newvce" + pnfs: + type: array + items: + $ref: "#/getDefinitions/pnf" + physical-links: + type: array + items: + $ref: "#/getDefinitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/getDefinitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/getDefinitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/getDefinitions/instance-group" + zones: + type: array + items: + $ref: "#/getDefinitions/zone" + configurations: + type: array + items: + $ref: "#/getDefinitions/configuration" + forwarding-paths: + type: array + items: + $ref: "#/getDefinitions/forwarding-path" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/getDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/getDefinitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO. + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/getDefinitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/getDefinitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/getDefinitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/getDefinitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/getDefinitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: object + $ref: "#/getDefinitions/model-vers" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/getDefinitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + selflink: + type: string + description: URL to endpoint where AAI can get more details. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + inv-status: + type: string + description: inventory status + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + sriov-pfs: + type: array + items: + $ref: "#/getDefinitions/sriov-pf" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/getDefinitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/getDefinitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/getDefinitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + selflink: + type: string + description: URL to endpoint where AAI can get more details. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + nf-role: + type: string + description: Nf Role is the role performed by this instance in the network. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/getDefinitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + port-group-id: + type: string + description: Unique ID for port group in vmware + port-group-name: + type: string + description: Likely to duplicate value of neutron network name + switch-name: + type: string + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + cvlan-tags: + type: array + items: + $ref: "#/getDefinitions/cvlan-tag-entry" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/getDefinitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/getDefinitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + resource-version: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/getDefinitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + pserver-name2: + type: string + description: alternative pserver name + purpose: + type: string + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + management-option: + type: string + description: Indicates who owns and or manages the device. + host-profile: + type: string + description: The host profile that defines the configuration of the pserver. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/getDefinitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/getDefinitions/named-query" + overloaded-model: + type: object + $ref: "#/getDefinitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + resource-version: + type: string + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/getDefinitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + relationship-label: + type: string + description: The edge label for this relationship. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/getDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/getDefinitions/related-to-property" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/getDefinitions/relationship" + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/getDefinitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/getDefinitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/getDefinitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + site-pairs: + type: array + items: + $ref: "#/getDefinitions/site-pair" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/getDefinitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/getDefinitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/getDefinitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/getDefinitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/getDefinitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/getDefinitions/search-results" + sdn-zone-response: + type: object + $ref: "#/getDefinitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/getDefinitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/getDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/getDefinitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-version: + type: string + description: service version + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/getDefinitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/getDefinitions/vnf-image" + services: + type: array + items: + $ref: "#/getDefinitions/service" + service-capabilities: + type: array + items: + $ref: "#/getDefinitions/service-capability" + models: + type: array + items: + $ref: "#/getDefinitions/model" + named-queries: + type: array + items: + $ref: "#/getDefinitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + - service-type + - service-role + - created-at + - updated-at + - description + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: Path to the controller object. + orchestration-status: + type: string + description: Orchestration status of this service. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + allotted-resources: + type: array + items: + $ref: "#/getDefinitions/allotted-resource" + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/getDefinitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-instances: + type: array + items: + $ref: "#/getDefinitions/service-instance" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/getDefinitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/getDefinitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + classes-of-service: + type: array + items: + $ref: "#/getDefinitions/class-of-service" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + routing-instances: + type: array + items: + $ref: "#/getDefinitions/routing-instance" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/getDefinitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/getDefinitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/getDefinitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/getDefinitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mac-anti-spoof-check: + type: boolean + description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/getDefinitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + - SUBNET is DELETED when these are DELETED HOST-ROUTE + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + subnet-sequence: + type: integer + format: int32 + description: sequence of the subnet + host-routes: + type: array + items: + $ref: "#/getDefinitions/host-route" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/getDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/getDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vservers: + type: array + items: + $ref: "#/getDefinitions/vserver" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/getDefinitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/getDefinitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/getDefinitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/getDefinitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: Loopback0 address + entitlement-resource-uuid: + type: string + description: OBSOLETE - see child relationships + port-groups: + type: array + items: + $ref: "#/getDefinitions/port-group" + licenses: + type: array + items: + $ref: "#/getDefinitions/license" + entitlements: + type: array + items: + $ref: "#/getDefinitions/entitlement" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/getDefinitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - VF-MODULE cannot be deleted if linked to VNFC + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + contrail-service-instance-fqdn: + type: string + description: the Contrail unique ID for a service-instance + module-index: + type: integer + format: int32 + description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit + selflink: + type: string + description: Path to the controller object. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/getDefinitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/getDefinitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/getDefinitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + vlan-description: + type: string + description: Used to describe (the service associated with) the vlan + backdoor-connection: + type: string + description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. + vpn-key: + type: string + description: This indicates the customers VPN ID associated with this vlan + orchestration-status: + type: string + description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + vlans: + properties: + vlan: + type: array + items: + $ref: "#/getDefinitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/getDefinitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/getDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/getDefinitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/getDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + route-targets: + type: array + items: + $ref: "#/getDefinitions/route-target" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/getDefinitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volumes: + type: array + items: + $ref: "#/getDefinitions/volume" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/getDefinitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Largeā€¦] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/getDefinitions/zone" -- cgit 1.2.3-korg