From 977df13b04fc6979a16afc229ae9644f29c704d6 Mon Sep 17 00:00:00 2001 From: Venkata Harish K Kajur Date: Thu, 10 Aug 2017 15:51:47 -0400 Subject: [AAI-150 Amsterdam] Modify xsd generation Modifying the way the xsd generation works due to the changes in the db edge rules change Change-Id: I585fde89b9a3a556021f1b94101c39dd83a97284 Signed-off-by: Venkata Harish K Kajur --- .../aai_swagger_html/aai_swagger_v11.html | 173136 ++++++++++++++++++ .../aai_swagger_yaml/aai_swagger_v11.yaml | 48655 +++++ 2 files changed, 221791 insertions(+) create mode 100644 aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html create mode 100644 aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml (limited to 'aai-schema/src/main/resources') diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html new file mode 100644 index 00000000..23c2ac4b --- /dev/null +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html @@ -0,0 +1,173136 @@ + + + + + + + + Active and Available Inventory REST API. + + +
+

Active and Available Inventory REST API.

+

Version: v11

+

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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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}/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

+
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

+
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

+
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

+
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/pservers

returns pservers

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

returns pserver

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

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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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: LicenseManagement

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /license-management/license-key-resources

returns license-key-resources

+
GET /license-management/license-key-resources/license-key-resource/{att-uuid}

returns license-key-resource

+
PUT /license-management/license-key-resources/license-key-resource/{att-uuid}

create or update an existing license-key-resource

+
DELETE /license-management/license-key-resources/license-key-resource/{att-uuid}

delete an existing license-key-resource

+
PUT /license-management/license-key-resources/license-key-resource/{att-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /license-management/license-key-resources/license-key-resource/{att-uuid}/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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
+ + +

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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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/{att-uuid}

returns vnf-image

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

create or update an existing vnf-image

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

delete an existing vnf-image

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

see node definition for valid relationships

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

delete an existing relationship

+
+ + +

Tag: Network

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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

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

delete an existing subnet

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc

+
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/vpes

returns vpes

+
GET /network/vpes/vpe/{vnf-id}

returns vpe

+
PUT /network/vpes/vpe/{vnf-id}

create or update an existing vpe

+
DELETE /network/vpes/vpe/{vnf-id}

delete an existing vpe

+
GET /network/vpes/vpe/{vnf-id}/entitlements

returns entitlements

+
GET /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

+
PUT /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

+
DELETE /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /network/vpes/vpe/{vnf-id}/l-interfaces

returns l-interfaces

+
GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

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

returns sriov-vf

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

create or update an existing sriov-vf

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

delete an existing sriov-vf

+
PUT /network/vpes/vpe/{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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

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

delete an existing relationship

+
GET /network/vpes/vpe/{vnf-id}/lag-interfaces

returns lag-interfaces

+
GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

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

returns sriov-vfs

+
GET /network/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

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

returns vlan

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

create or update an existing vlan

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

delete an existing vlan

+
GET /network/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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

+
DELETE /network/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{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/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpes/vpe/{vnf-id}/licenses

returns licenses

+
GET /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

returns license

+
PUT /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

+
DELETE /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

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

see node definition for valid relationships

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

delete an existing relationship

+
PUT /network/vpes/vpe/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpes/vpe/{vnf-id}/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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+
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

+ +
+
+
+ +
+
+ +
+ /connectors +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /connector +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /connector +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /customers +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /service-subscriptions +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /service-subscription +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /service-instances +
+
+
+ +
+
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /service-instance +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /allotted-resources +
+
+
+ +
+
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /allotted-resource +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /tunnel-xconnects +
+
+
+ +
+
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /tunnel-xconnect +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + +
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 cloud-regions
+

GET /cloud-infrastructure/cloud-regions

+ Tags: + CloudInfrastructure +
+
+
+

returns cloud-regions

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /cloud-regions +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /cloud-region +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /cloud-region +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /availability-zones +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /availability-zone +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /availability-zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /dvs-switches +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /dvs-switch +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /dvs-switch +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /flavor +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /group-assignments +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /group-assignment +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /group-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /oam-networks +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /oam-network +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /oam-network +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /snapshots +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+

+
+
+
+
+ /snapshot +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+
+ +
+

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

+

+
+
+
+
+ /tenant +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+
+ +
+

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, e.g., att-aic. 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 + + +
+ 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

+

+
+
+
+
+ /vserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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, e.g., att-aic. 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 + + +
+ 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

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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, e.g., att-aic. 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 + + +
+ 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

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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, e.g., att-aic. 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 + + +
+ 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, e.g., att-aic. 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 + + +
+ 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

+

+
+
+
+
+ /volume +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /volume-groups +
+
+
+ +
+
+ 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /volume-group +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /volume-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name, e.g., att-aic. 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, e.g., att-aic. 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

+ +
+
+
+ +
+
+ +
+ /complexes +
+
+
+ +
+
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /ctag-pools +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /ctag-pool +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /network-profiles +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /network-profile +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /network-profile +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 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

+

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

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /virtual-data-centers +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /virtual-data-center +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /virtual-data-center +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 license-key-resources
+

GET /license-management/license-key-resources

+ Tags: + LicenseManagement +
+
+
+

returns license-key-resources

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license-key-resources +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns license-key-resource
+

GET /license-management/license-key-resources/license-key-resource/{att-uuid}

+ Tags: + LicenseManagement +
+
+
+

returns license-key-resource

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ att-uuid + + path + string + + + +
+ assignment-group-uuid + + query + string + + +
+ name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license-key-resource +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing license-key-resource
+

PUT /license-management/license-key-resources/license-key-resource/{att-uuid}

+ Tags: + LicenseManagement +
+
+
+

create or update an existing license-key-resource

+ +
+
+ +

application/json application/xml +

+
+
+

license-key-resource object that needs to be created or updated

+

+
+
+
+
+ /license-key-resource +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ att-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing license-key-resource
+

DELETE /license-management/license-key-resources/license-key-resource/{att-uuid}

+ Tags: + LicenseManagement +
+
+
+

delete an existing license-key-resource

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ att-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 /license-management/license-key-resources/license-key-resource/{att-uuid}/relationship-list/relationship

+ Tags: + LicenseManagement +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ att-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /license-management/license-key-resources/license-key-resource/{att-uuid}/relationship-list/relationship

+ Tags: + LicenseManagement +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ att-uuid + + 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

+ +
+
+
+ +
+
+ +
+ /generic-vnfs +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /generic-vnf +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /generic-vnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /entitlement +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /vf-modules +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /vf-module +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /instance-groups +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /instance-group +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /instance-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /ipsec-configurations +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /ipsec-configuration +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /ipsec-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /vig-servers +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /vig-server +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-networks +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-network +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /l3-network +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /ctag-assignments +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /ctag-assignment +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /ctag-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /segmentation-assignments +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /segmentation-assignment +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /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.

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 lag-links
+

GET /network/lag-links

+ Tags: + Network +
+
+
+

returns lag-links

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-links +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-link
+

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

+ Tags: + Network +
+
+
+

returns lag-link

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-link +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-link
+

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

+ Tags: + Network +
+
+
+

create or update an existing lag-link

+ +
+
+ +

application/json application/xml +

+
+
+

lag-link object that needs to be created or updated

+

+
+
+
+
+ /lag-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-link
+

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

+ Tags: + Network +
+
+
+

delete an existing lag-link

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

+ 		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/lag-links/lag-link/{link-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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

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

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns logical-links
+

GET /network/logical-links

+ Tags: + Network +
+
+
+

returns logical-links

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /logical-links +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns logical-link
+

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

+ Tags: + Network +
+
+
+

returns logical-link

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		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 + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ link-id + +

UUID of the logical-link, SDNC generates this.

+ 		query + string + + +
+ circuit-id + +

Circuit id

+ 		query + string + + +
+ purpose + +

Reason for this entity, role it is playing

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /logical-link +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing logical-link
+

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

+ Tags: + Network +
+
+
+

create or update an existing logical-link

+ +
+
+ +

application/json application/xml +

+
+
+

logical-link object that needs to be created or updated

+

+
+
+
+
+ /logical-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing logical-link
+

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

+ Tags: + Network +
+
+
+

delete an existing logical-link

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		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/logical-links/logical-link/{link-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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

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

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		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

+ +
+
+
+ +
+
+ +
+ /multicast-configurations +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /multicast-configuration +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /multicast-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /network-policies +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /network-policy +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /network-policy +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 physical-links
+

GET /network/physical-links

+ Tags: + Network +
+
+
+

returns physical-links

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /physical-links +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns physical-link
+

GET /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

returns physical-link

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		path + string + + + +
+ circuit-id + +

Circuit it

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /physical-link +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing physical-link
+

PUT /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

create or update an existing physical-link

+ +
+
+ +

application/json application/xml +

+
+
+

physical-link object that needs to be created or updated

+

+
+
+
+
+ /physical-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing physical-link
+

DELETE /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

delete an existing physical-link

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		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/physical-links/physical-link/{link-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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		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

+

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

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /route-table-references +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /route-table-reference +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /route-table-reference +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /site-pair-sets +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /site-pair-set +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /site-pair-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /routing-instances +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /routing-instance +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /site-pairs +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /site-pair +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /classes-of-service +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /class-of-service +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /entitlement +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /port-groups +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /port-group +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /cvlan-tags +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /cvlan-tag-entry +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /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.

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 vpes
+

GET /network/vpes

+ Tags: + Network +
+
+
+

returns vpes

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vpes +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vpe
+

GET /network/vpes/vpe/{vnf-id}

+ Tags: + Network +
+
+
+

returns vpe

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vpe +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vpe
+

PUT /network/vpes/vpe/{vnf-id}

+ Tags: + Network +
+
+
+

create or update an existing vpe

+ +
+
+ +

application/json application/xml +

+
+
+

vpe object that needs to be created or updated

+

+
+
+
+
+ /vpe +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 vpe
+

DELETE /network/vpes/vpe/{vnf-id}

+ Tags: + Network +
+
+
+

delete an existing vpe

+ +
+
+ +

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/vpes/vpe/{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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlement
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlement +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing entitlement
+

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing entitlement
+

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+ 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/vpes/vpe/{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

+

+
+
+
+
+ /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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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/vpes/vpe/{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 map strictly 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 + + +
+ 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/vpes/vpe/{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

+

+
+
+
+
+ /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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-interface
+

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-interface
+

DELETE /network/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+ 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/vpes/vpe/{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

+

+
+
+
+
+ /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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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/vpes/vpe/{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 map strictly 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 + + +
+ 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/vpes/vpe/{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

+

+
+
+
+
+ /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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpes/vpe/{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

+

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns license
+

GET /network/vpes/vpe/{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 map strictly 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing license
+

PUT /network/vpes/vpe/{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

+

+
+
+
+
+ /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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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/vpes/vpe/{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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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/vpes/vpe/{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 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

+

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

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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

+

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

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /vpn-bindings +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /vpn-binding +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /vpn-binding +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /route-targets +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /route-target +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+ +
+
+
+ +
+
+ +
+ /model-vers +
+
+
+ +
+
+ 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-ver +
+
+
+ +
+
+ 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

+

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

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

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

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ 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

+

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

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

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-elements +
+
+
+ +
+
+ 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-element +
+
+
+ +
+
+ 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

+

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

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

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-constraints +
+
+
+ +
+
+ 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-constraint +
+
+
+ +
+
+ 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

+

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

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

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-sets +
+
+
+ +
+
+ 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-set +
+
+
+ +
+
+ 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

+

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

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

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /element-choice-sets +
+
+
+ +
+
+ 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 + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /element-choice-set +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /named-queries +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /named-query +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /named-query +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /named-query-elements +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /named-query-element +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /named-query-element +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /property-constraints +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /property-constraint +
+
+
+ +
+
+ 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

+

+
+
+
+
+ /property-constraint +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

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

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns related-lookups

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /related-lookups +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns related-lookup
+

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}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns related-lookup

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /related-lookup +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update 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}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing related-lookup

+ +
+
+ +

application/json application/xml +

+
+
+

related-lookup object that needs to be created or updated

+

+
+
+
+
+ /related-lookup +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete 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}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing related-lookup

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-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}/related-lookups/related-lookup/{related-lookup-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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-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}/related-lookups/related-lookup/{related-lookup-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 + + + +
+ related-lookup-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}/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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /service-capabilities +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /service-capability +
+
+
+ +
+
+ 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

+

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

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /vnf-images +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnf-image
+

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

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns vnf-image

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

+ +
+
+
+ +
+
+ +
+ /vnf-image +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vnf-image
+

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

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+

vnf-image object that needs to be created or updated

+

+
+
+
+
+ /vnf-image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ att-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/{att-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ att-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/{att-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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ att-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/{att-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ att-uuid + +

Unique ID of this asset

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +

Schema definitions

+ +
+
+

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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO generic-vnf (Many2Many)
    • +
  • TO l3-network (Many2Many)
    • +
  • TO instance-group (Many2Many)
    • +
  • TO network-policy (One2One)
    • +
  • TO vlan (Many2Many)
    • +
  • TO l-interface (One2Many)
    • +
  • TO tunnel-xconnect (comprises allotted-resource, One2One)
    • +
  • TO vpn-binding (Many2Many)
    • +
  • FROM service-instance (is composed of allotted-resource)
    • +
  • FROM service-instance
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

+ +
    +
  • TO complex (Many2Many)
    • +
  • TO service-capability (Many2Many)
    • +
  • FROM cloud-region (is composed of availability-zone)
    • +
  • FROM ctag-pool
    • +
  • FROM dvs-switch
    • +
  • FROM generic-vnf
    • +
  • FROM pserver
    • +
  • FROM 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

class-of-service: + object + + + +

+
+
+
+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM site-pair (is composed of class-of-service)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-region: + object + + + +

+
+
+
+

cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC 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 and we will use att-aic for AT&T's AIC.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO complex (Many2One)
    • +
  • TO l3-network (Many2Many)
    • +
  • TO tenant (comprises cloud-region, One2Many)
    • +
  • TO image (comprises cloud-region, One2Many)
    • +
  • TO flavor (comprises cloud-region, One2Many)
    • +
  • TO availability-zone (comprises cloud-region, One2Many)
    • +
  • TO oam-network (comprises cloud-region, One2Many)
    • +
  • TO dvs-switch (comprises cloud-region, One2Many)
    • +
  • TO volume-group (comprises cloud-region, One2Many)
    • +
  • TO group-assignment (comprises cloud-region, One2Many)
    • +
  • TO snapshot (comprises cloud-region, One2Many)
    • +
  • TO zone (Many2One)
    • +
  • FROM pserver
    • +
  • FROM logical-link
+ +
+ +
+
+
+ cloud-owner: + string + + + +
+
+

Identifies the vendor and cloud name, e.g., att-aic. 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 + + + +
+
+
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-regions: + object + + + +

+
+
+ +
+
+
+ cloud-region: + object[] + + +
+
+ +
+ +
+ cloud-region + + + +
+ +
+
+
+
+
+
+
+
+
+

complex: + object + + + +

+
+
+
+

Collection of physical locations that can house cloud-regions.

+
Default Delete Scope
+

ERROR_4_IN_EDGES_OR_CASCADE

+ +
    +
  • TO ctag-pool (comprises complex, Many2Many)
    • +
  • TO l3-network (Many2Many)
    • +
  • FROM availability-zone
    • +
  • FROM cloud-region
    • +
  • FROM oam-network
    • +
  • FROM pserver
    • +
  • FROM pnf
    • +
  • FROM vce
    • +
  • FROM vpe
    • +
  • FROM vpls-pe
    • +
  • FROM volume-group
    • +
  • FROM zone
    • +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

connector: + object + + + +

+
+
+
+

Collection of resource instances used to connect a variety of disparate inventory widgets

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO virtual-data-center (Many2Many)
    • +
  • TO metadatum (comprises connector, Many2Many)
    • +
  • FROM service-instance
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO element-choice-set (comprises constrained-element-set, One2Many)
    • +
  • FROM model-element (is composed of constrained-element-set)
    • +
  • FROM model-constraint (is composed of constrained-element-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 + + + +

+
+
+
+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM l3-network (is composed of ctag-assignment)
    • +
  • FROM service-instance
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO availability-zone (Many2Many)
    • +
  • FROM complex (is composed of ctag-pool)
    • +
  • FROM vpe
    • +
  • FROM vpls-pe
    • +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO service-subscription (comprises customer, Many2Many)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO availability-zone (Many2Many)
    • +
  • FROM cloud-region (is composed of dvs-switch)
+ +
+ +
+
+
+ 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 VPEs.

+ +
+ +
+
+
+ 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 + + +
+
+
+ +
+
+
+ isParent: + boolean + + +
+
+
+ +
+
+
+ usesResource: + boolean + + +
+
+
+ +
+
+
+ hasDelTarget: + boolean + + +
+
+
+ +
+
+
+ SVC-INFRA: + boolean + + +
+
+
+ +
+
+
+ SVC-INFRA-REV: + boolean + + +
+
+
+ +
+
+
+
+
+
+
+
+

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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO model-element (comprises element-choice-set, One2Many)
    • +
  • FROM constrained-element-set (is composed of element-choice-set)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM generic-vnf (is composed of entitlement)
    • +
  • FROM vce (is composed of entitlement)
    • +
  • FROM vpe (is composed of entitlement)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

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.

+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

+ +
    +
  • FROM cloud-region (is composed of flavor)
    • +
  • FROM 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

generic-vnf: + object + + + +

+
+
+
+

General purpose VNF

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO license-key-resource (Many2Many)
    • +
  • TO l-interface (comprises generic-vnf, Many2Many)
    • +
  • TO availability-zone (Many2Many)
    • +
  • TO lag-interface (comprises generic-vnf, Many2Many)
    • +
  • TO l3-network (Many2Many)
    • +
  • TO pserver (Many2Many)
    • +
  • TO vnf-image (Many2One)
    • +
  • TO vserver (One2Many)
    • +
  • TO service-instance (Many2Many)
    • +
  • TO site-pair-set (Many2Many)
    • +
  • TO network-profile (Many2Many)
    • +
  • TO pnf (Many2Many)
    • +
  • TO ipsec-configuration (Many2One)
    • +
  • TO vf-module (comprises generic-vnf, One2Many)
    • +
  • TO volume-group (One2Many)
    • +
  • TO vnfc (One2Many, will delete target node)
    • +
  • TO instance-group (Many2Many)
    • +
  • TO entitlement (comprises generic-vnf, One2Many)
    • +
  • TO license (comprises generic-vnf, One2Many)
    • +
  • TO complex (Many2Many)
    • +
  • TO ctag-pool (Many2Many)
    • +
  • FROM virtual-data-center
    • +
  • FROM logical-link
    • +
  • FROM allotted-resource
+ +
+ +
+
+
+ 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 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.

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

+
+ +
+
+
+ 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).

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO tenant (Many2Many)
    • +
  • TO pserver (One2Many)
    • +
  • FROM cloud-region (is composed of group-assignment)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

image: + object + + + +

+
+
+
+

Openstack image.

+
Default Delete Scope
+

ERROR_4_IN_EDGES_OR_CASCADE

+ +
    +
  • TO metadata (comprises image, Many2Many)
    • +
  • TO metadatum (comprises image, Many2Many)
    • +
  • FROM cloud-region (is composed of image)
    • +
  • FROM vserver
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO model (Many2Many)
    • +
  • FROM l-interface
    • +
  • FROM vnfc
    • +
  • FROM l3-interface-ipv4-address-list
    • +
  • FROM l3-interface-ipv6-address-list
    • +
  • FROM l3-network
    • +
  • FROM pnf
    • +
  • FROM allotted-resource
    • +
  • FROM generic-vnf
    • +
  • FROM service-instance
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+ license-management: + object + + +
+
+ +
+ +
+ license-management + + + +
+ +
+
+
+
+ business: + object + + +
+
+ +
+ +
+ business + + + +
+ +
+
+
+
+ service-design-and-creation: + object + + +
+
+ +
+ +
+ service-design-and-creation + + + +
+ +
+
+
+
+ network: + object + + +
+
+ +
+ +
+ network + + + +
+ +
+
+
+
+ aai-internal: + object + + +
+
+ +
+ +
+ aai-internal + + + +
+ +
+
+
+
+ nodes: + object[] + + +
+
+ +
+ +
+ + + + +
+ +
+
+
+
+
+
+
+
+
+

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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO vig-server (comprises ipsec-configuration, One2Many)
    • +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO instance-group (Many2Many)
    • +
  • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
    • +
  • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
    • +
  • TO l-interface (comprises l-interface, One2Many)
    • +
  • TO logical-link (Many2Many, will delete target node)
    • +
  • TO vlan (comprises l-interface, Many2Many)
    • +
  • TO sriov-vf (comprises l-interface, One2One)
    • +
  • FROM generic-vnf (is composed of l-interface)
    • +
  • FROM lag-interface (is composed of l-interface)
    • +
  • FROM newvce (is composed of l-interface)
    • +
  • FROM p-interface (is composed of l-interface)
    • +
  • FROM vpe (is composed of l-interface)
    • +
  • FROM vserver (is composed of l-interface)
    • +
  • FROM allotted-resource
    • +
  • FROM l-interface (is composed of l-interface)
+ +
+ +
+
+
+ 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].

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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO instance-group (Many2Many)
    • +
  • TO l3-network (Many2Many)
    • +
  • TO subnet (Many2Many)
    • +
  • FROM l-interface (is composed of l3-interface-ipv4-address-list)
    • +
  • FROM vlan (is composed of l3-interface-ipv4-address-list)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO instance-group (Many2Many)
    • +
  • TO l3-network (Many2Many)
    • +
  • TO subnet (Many2Many)
    • +
  • FROM l-interface (is composed of l3-interface-ipv6-address-list)
    • +
  • FROM vlan (is composed of l3-interface-ipv6-address-list)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO vpn-binding (Many2Many)
    • +
  • TO instance-group (Many2Many)
    • +
  • TO subnet (comprises l3-network, Many2Many)
    • +
  • TO service-instance (Many2Many)
    • +
  • TO ctag-assignment (comprises l3-network, Many2Many)
    • +
  • TO network-policy (Many2Many)
    • +
  • TO segmentation-assignment (comprises l3-network, One2Many)
    • +
  • TO route-table-reference (Many2Many)
    • +
  • FROM cloud-region
    • +
  • FROM complex
    • +
  • FROM generic-vnf
    • +
  • FROM l3-interface-ipv4-address-list
    • +
  • FROM l3-interface-ipv6-address-list
    • +
  • FROM tenant
    • +
  • FROM vf-module
    • +
  • FROM allotted-resource
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO logical-link (Many2Many, will delete target node)
    • +
  • TO lag-link (Many2Many, will delete target node)
    • +
  • TO p-interface (Many2Many)
    • +
  • TO l-interface (comprises lag-interface, Many2Many)
    • +
  • FROM generic-vnf (is composed of lag-interface)
    • +
  • FROM pserver (is composed of lag-interface)
    • +
  • FROM pnf (is composed of lag-interface)
    • +
  • FROM vpe (is composed of lag-interface)
    • +
  • FROM vpls-pe (is composed of lag-interface)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM generic-vnf (is composed of license)
    • +
  • FROM vce (is composed of license)
    • +
  • FROM vpe (is composed of license)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

license-key-resource: + object + + + +

+
+
+
+

OBSOLETE OBJECT: do not use

+ +
    +
  • FROM generic-vnf
+ +
+ +
+
+
+ att-uuid: + string + + + +
+
+
+ +
+
+
+ assignment-type: + string + + +
+
+
+ +
+
+
+ assignment-status: + string + + +
+
+
+ +
+
+
+ assignment-group-uuid: + string + + + +
+
+
+ +
+
+
+ assignment-date: + string + + +
+
+
+ +
+
+
+ name: + string + + +
+
+
+ +
+
+
+ model-uuid: + string + + +
+
+
+ +
+
+
+ model-version: + string + + +
+
+
+ +
+
+
+ license-key: + string + + +
+
+
+ +
+
+
+ license-key-file-url: + string + + +
+
+
+ +
+
+
+ supplier-release-list: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

license-key-resources: + object + + + +

+
+
+ +
+
+
+ license-key-resource: + object[] + + +
+
+ +
+ +
+ license-key-resource + + + +
+ +
+
+
+
+
+
+
+
+
+

license-management: + object + + + +

+
+
+ +
+
+
+ license-key-resources: + object[] + + +
+
+ +
+ +
+ license-key-resource + + + +
+ +
+
+
+
+
+
+
+
+
+

licenses: + object + + + +

+
+
+
+

Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

+ +
+ +
+
+
+ license: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

metadata: + object + + + +

+
+
+
+

Collection of metadatum (key/value pairs)

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM image (is composed of metadata)
+ +
+ +
+
+
+ metadatum: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

metadatum: + object + + + +

+
+
+
+

Key/value pairs

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM image (is composed of metadatum)
    • +
  • FROM model-ver (is composed of metadatum)
    • +
  • FROM service-instance (is composed of metadatum)
    • +
  • FROM connector (is composed of metadatum)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

ERROR_4_IN_EDGES_OR_CASCADE

+ +
    +
  • TO model-ver (comprises model, One2Many)
    • +
  • FROM named-query
    • +
  • FROM named-query-element
    • +
  • FROM instance-group
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO constrained-element-set (comprises model-constraint, One2Many)
    • +
  • FROM model-element (is composed of model-constraint)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO model-ver (Many2One)
    • +
  • TO model-element (comprises model-element, One2Many)
    • +
  • TO model-constraint (comprises model-element, One2Many)
    • +
  • TO constrained-element-set (comprises model-element, One2Many)
    • +
  • FROM model-ver (is composed of model-element)
    • +
  • FROM element-choice-set (is composed of model-element)
    • +
  • FROM model-element (is composed of model-element)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

ERROR_4_IN_EDGES_OR_CASCADE

+ +
    +
  • TO model-element (comprises model-ver, One2Many)
    • +
  • TO metadatum (comprises model-ver, One2Many)
    • +
  • FROM model (is composed of model-ver)
    • +
  • FROM 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

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

+
+
+
+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM vlan
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO model (One2Many)
    • +
  • TO named-query-element (comprises named-query, One2One)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO named-query-element (comprises named-query-element, Many2Many)
    • +
  • TO model (Many2One)
    • +
  • TO property-constraint (comprises named-query-element, One2Many)
    • +
  • TO related-lookup (comprises named-query-element, One2Many)
    • +
  • FROM named-query (is composed of named-query-element)
    • +
  • FROM named-query-element (is composed of named-query-element)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+ vpes: + object[] + + +
+
+ +
+ +
+ vpe + + + +
+ +
+
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

network-policies: + object + + + +

+
+
+ +
+
+
+ network-policy: + object[] + + +
+
+ +
+ +
+ network-policy + + + +
+ +
+
+
+
+
+
+
+
+
+

network-policy: + object + + + +

+
+
+
+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM l3-network
    • +
  • FROM allotted-resource
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO l-interface (comprises newvce, Many2Many)
+ +
+ +
+
+
+ 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 vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value, e.g., VPE.

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

+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

+ +
    +
  • TO complex (Many2Many)
    • +
  • TO service-capability (Many2Many)
    • +
  • FROM cloud-region (is composed of oam-network)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

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

p-interface: + object + + + +

+
+
+
+

Physical interface (e.g., nic)

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO l-interface (comprises p-interface, Many2Many)
    • +
  • TO physical-link (Many2Many, will delete target node)
    • +
  • TO logical-link (Many2One)
    • +
  • TO sriov-pf (comprises p-interface, One2One)
    • +
  • FROM lag-interface
    • +
  • FROM pserver (is composed of p-interface)
    • +
  • FROM pnf (is composed of p-interface)
    • +
  • FROM vpls-pe (is composed of p-interface)
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name that identifies the physical interface

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

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

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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO p-interface (comprises pnf, Many2Many)
    • +
  • TO lag-interface (comprises pnf, One2Many)
    • +
  • TO complex (Many2One)
    • +
  • TO instance-group (Many2Many)
    • +
  • TO zone (Many2One)
    • +
  • FROM generic-vnf
    • +
  • FROM logical-link
    • +
  • FROM service-instance
+ +
+ +
+
+
+ pnf-name: + string + + + +
+
+

unique name of Physical Network Function.

+
+ +
+
+
+ pnf-name2: + string + + +
+
+

name of Physical Network Function.

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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO cvlan-tag (comprises port-group, Many2Many)
    • +
  • FROM vce (is composed of port-group)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

properties: + object + + + +

+
+
+
+

Property holder for query properties or instance properties

+ +
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

property-constraint: + object + + + +

+
+
+
+

TBD

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • FROM named-query-element (is composed of property-constraint)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

ERROR_4_IN_EDGES_OR_CASCADE

+ +
    +
  • TO complex (Many2One)
    • +
  • TO cloud-region (Many2One)
    • +
  • TO availability-zone (Many2One)
    • +
  • TO lag-interface (comprises pserver, Many2Many)
    • +
  • TO p-interface (comprises pserver, Many2Many)
    • +
  • TO zone (Many2One)
    • +
  • FROM generic-vnf
    • +
  • FROM group-assignment
    • +
  • FROM vserver
    • +
  • FROM logical-link
+ +
+ +
+
+
+ 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.

+
+ +
+
+
+ related-link: + string + + +
+
+

URL to the object in A&AI.

+
+ +
+
+
+ relationship-data: + object[] + + +
+
+ +
+ +
+ relationship-data + + + +
+ +
+
+
+
+ related-to-property: + object[] + + +
+
+ +
+ +
+ related-to-property + + + +
+ +
+
+
+
+
+
+
+
+
+

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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM l3-network
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • FROM vpn-binding (is composed of route-target)
+ +
+ +
+
+
+ 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 + + + +

+
+
+
+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO site-pair (comprises routing-instance, Many2Many)
    • +
  • FROM site-pair-set (is composed of routing-instance)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM l3-network (is composed of segmentation-assignment)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

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

+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

+ +
    +
  • FROM availability-zone
    • +
  • FROM 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO zone (Many2One)
    • +
  • TO cvlan-tag (Many2Many)
    • +
  • TO pnf (One2Many)
    • +
  • TO connector (Many2Many)
    • +
  • TO metadatum (comprises service-instance, Many2Many)
    • +
  • TO logical-link (Many2Many, will delete target node)
    • +
  • TO vlan (One2Many)
    • +
  • TO service-instance (One2Many)
    • +
  • TO ctag-assignment (One2Many)
    • +
  • TO instance-group (Many2Many)
    • +
  • TO allotted-resource (comprises service-instance, Many2Many)
    • +
  • TO allotted-resource (Many2Many)
    • +
  • FROM generic-vnf
    • +
  • FROM l3-network
    • +
  • FROM service-subscription (is composed of service-instance)
    • +
  • FROM vce
    • +
  • FROM service-instance
+ +
+ +
+
+
+ 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.

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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO service-instance (comprises service-subscription, Many2Many)
    • +
  • FROM customer (is composed of service-subscription)
    • +
  • FROM tenant
+ +
+ +
+
+
+ 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 + + + +

+
+
+
+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO class-of-service (comprises site-pair, Many2Many)
    • +
  • FROM routing-instance (is composed of site-pair)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO routing-instance (comprises site-pair-set, Many2Many)
    • +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM cloud-region (is composed of snapshot)
    • +
  • FROM vserver
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM p-interface (is composed of sriov-pf)
    • +
  • FROM sriov-vf
+ +
+ +
+
+
+ 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)

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO sriov-pf (Many2One)
    • +
  • FROM l-interface (is composed of sriov-vf)
+ +
+ +
+
+
+ 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 + + + +

+
+
+
+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

+ +
    +
  • FROM l3-interface-ipv4-address-list
    • +
  • FROM l3-interface-ipv6-address-list
    • +
  • FROM l3-network (is composed of subnet)
+ +
+ +
+
+
+ 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

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

subnets: + object + + + +

+
+
+ +
+
+
+ subnet: + object[] + + +
+
+ +
+ +
+ subnet + + + +
+ +
+
+
+
+
+
+
+
+
+

tagged-inventory-item-list: + object + + + +

+
+
+ +
+
+
+ inventory-item: + object[] + + +
+
+ +
+ +
+ inventory-item + + + +
+ +
+
+
+
+
+
+
+
+
+

tenant: + object + + + +

+
+
+
+

Openstack tenant

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO l3-network (Many2Many)
    • +
  • TO service-subscription (Many2Many)
    • +
  • TO vserver (comprises tenant, One2Many)
    • +
  • FROM cloud-region (is composed of tenant)
    • +
  • FROM group-assignment
    • +
  • FROM volume-group
+ +
+ +
+
+
+ tenant-id: + string + + + +
+
+

Unique id relative to the cloud-region.

+
+ +
+
+
+ tenant-name: + string + + + +
+
+

Readable name of tenant

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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM allotted-resource (is composed of tunnel-xconnect)
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO availability-zone (Many2Many)
    • +
  • TO complex (Many2Many)
    • +
  • TO port-group (comprises vce, Many2Many)
    • +
  • TO vserver (Many2Many)
    • +
  • TO service-instance (Many2Many)
    • +
  • TO entitlement (comprises vce, One2Many)
    • +
  • TO license (comprises vce, One2Many)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO volume-group (One2One)
    • +
  • TO l3-network (Many2Many)
    • +
  • TO vnfc (One2Many, will delete target node)
    • +
  • FROM vserver
    • +
  • FROM generic-vnf (is composed of vf-module)
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM ipsec-configuration (is composed of vig-server)
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

virtual-data-center: + object + + + +

+
+
+
+

Virtual organization of cloud infrastructure elements in a data center context

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO generic-vnf (Many2Many)
    • +
  • TO logical-link (Many2Many)
    • +
  • FROM connector
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
    • +
  • TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
    • +
  • TO multicast-configuration (Many2Many)
    • +
  • TO logical-link (Many2Many, will delete target node)
    • +
  • FROM l-interface (is composed of vlan)
    • +
  • FROM service-instance
    • +
  • FROM allotted-resource
+ +
+ +
+
+
+ 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].

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

+
Default Delete Scope
+

ERROR_IF_ANY_IN_EDGES

+ +
    +
  • FROM generic-vnf
+ +
+ +
+
+
+ att-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 + + + +

+
+
+
+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO instance-group (Many2Many)
    • +
  • FROM vserver
    • +
  • FROM vf-module
    • +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

vnfcs: + object + + + +

+
+
+
+

virtual network components associated with a vserver from application controller.

+ +
+ +
+
+
+ vnfc: + object[] + + +
+
+ +
+ +
+ vnfc + + + +
+ +
+
+
+
+
+
+
+
+
+

volume: + object + + + +

+
+
+
+

Ephemeral Block storage volume.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • FROM vserver (is composed of 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.

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO complex (Many2Many)
    • +
  • TO tenant (Many2Many)
    • +
  • FROM cloud-region (is composed of volume-group)
    • +
  • FROM vf-module
    • +
  • FROM generic-vnf
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

vpe: + object + + + +

+
+
+
+

Relationship-list must include related to info for complex.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO complex (Many2Many)
    • +
  • TO ctag-pool (Many2Many)
    • +
  • TO l-interface (comprises vpe, Many2Many)
    • +
  • TO lag-interface (comprises vpe, Many2Many)
    • +
  • TO vserver (Many2Many)
    • +
  • TO entitlement (comprises vpe, One2Many)
    • +
  • TO license (comprises vpe, One2Many)
+ +
+ +
+
+
+ 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 map strictly 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. See child relationships.

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value

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

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).

+
+ +
+
+
+ ipv4-oam-gateway-address-prefix-length: + integer + + +
+
+

Prefix length for oam-address

+
+ +
+
+
+ ipv4-oam-gateway-address: + string + + +
+
+

Gateway address

+
+ +
+
+
+ v4-loopback0-ip-address: + string + + +
+
+

Loopback0 address

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Temporary location for stag to get to VCE

+
+ +
+
+
+ as-number: + string + + +
+
+

as-number of the VPE

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ summary-status: + string + + +
+
+

details regarding the vpe operation, PLEASE DISCONTINUE USE OF THIS FIELD.

+
+ +
+
+
+ encrypted-access-flag: + boolean + + +
+
+

indicates whether vpe access uses SSH

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+ licenses: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+ entitlements: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+
+
+
+
+
+

vpes: + object + + + +

+
+
+
+

Virtual provider edge router. In 1504, A&AI will populate this object through an M&P and tool provided to operations.

+ +
+ +
+
+
+ vpe: + object[] + + +
+
+ +
+ +
+ vpe + + + +
+ +
+
+
+
+
+
+
+
+
+

vpls-pe: + object + + + +

+
+
+
+

VPLS Provider Edge routers.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO complex (Many2Many)
    • +
  • TO ctag-pool (Many2Many)
    • +
  • TO p-interface (comprises vpls-pe, Many2Many)
    • +
  • TO lag-interface (comprises vpls-pe, Many2Many)
+ +
+ +
+
+
+ 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 vpe, also used for troubleshooting and is IP used for traps generated by VPE (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

+
Default Delete Scope
+

ERROR_4_IN_EDGES_OR_CASCADE

+ +
    +
  • TO route-target (comprises vpn-binding, One2Many)
    • +
  • FROM l3-network
    • +
  • FROM logical-link
    • +
  • FROM allotted-resource
+ +
+ +
+
+
+ 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.

+
Default Delete Scope
+

CASCADE_TO_CHILDREN

+ +
    +
  • TO flavor (Many2One)
    • +
  • TO image (Many2One)
    • +
  • TO ipaddress (comprises vserver, Many2Many)
    • +
  • TO l-interface (comprises vserver, Many2Many)
    • +
  • TO pserver (Many2One)
    • +
  • TO volume (comprises vserver, Many2Many)
    • +
  • TO vnfc (Many2Many)
    • +
  • TO snapshot (One2One)
    • +
  • TO vf-module (Many2One)
    • +
  • FROM generic-vnf
    • +
  • FROM tenant (is composed of vserver)
    • +
  • FROM vce
    • +
  • FROM vpe
+ +
+ +
+
+
+ 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

+
Default Delete Scope
+

THIS_NODE_ONLY

+ +
    +
  • TO complex (Many2One)
    • +
  • FROM cloud-region
    • +
  • FROM pserver
    • +
  • FROM pnf
    • +
  • FROM service-instance
+ +
+ +
+
+
+ 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_v11.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml new file mode 100644 index 00000000..1e2e70f7 --- /dev/null +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml @@ -0,0 +1,48655 @@ +swagger: "2.0" +info: + description: | + 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: "v11" + 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/v11 +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 + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + /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: "#/definitions/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 + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + - 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 + 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 + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + - name: body + in: body + description: ctag-pool object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: complex object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + - name: body + in: body + description: volume-group object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + 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}: + get: + tags: + - CloudInfrastructure + summary: returns volume + description: returns volume + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + - name: body + in: body + description: volume object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - 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: 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + 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}/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + 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/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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + 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-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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - 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: 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - 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: 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - name: body + in: body + description: vserver object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - 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 + /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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing tenant + description: create or update an existing tenant + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - name: body + in: body + description: tenant object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + - name: body + in: body + description: flavor object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + - name: body + in: body + description: group-assignment object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + - name: body + in: body + description: snapshot object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - name: metaname + in: path + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - name: metaname + in: path + required: true + type: string + - name: body + in: body + description: metadatum object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - name: metaname + in: path + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - name: body + in: body + description: image object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + - name: body + in: body + description: dvs-switch object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + - name: body + in: body + description: oam-network object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + /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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + - name: body + in: body + description: availability-zone object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + - 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + 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: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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 + 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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - name: body + in: body + description: cloud-region object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing network-profile + description: create or update an existing network-profile + 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 + - name: body + in: body + description: network-profile object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - name: body + in: body + description: sriov-pf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: body + in: body + description: p-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + 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}/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: lag-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/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 + - 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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: pserver object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: virtual-data-center object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/virtual-data-centers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /license-management/license-key-resources/license-key-resource/{att-uuid}/relationship-list/relationship: + put: + tags: + - LicenseManagement + summary: see node definition for valid relationships + operationId: createOrUpdateLicenseManagementLicenseKeyResourcesLicenseKeyResourceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: att-uuid + in: path + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - LicenseManagement + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteLicenseManagementLicenseKeyResourcesLicenseKeyResourceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: att-uuid + in: path + required: true + type: string + /license-management/license-key-resources/license-key-resource/{att-uuid}: + get: + tags: + - LicenseManagement + summary: returns license-key-resource + description: returns license-key-resource + operationId: getLicenseManagementLicenseKeyResourcesLicenseKeyResource + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/license-key-resource" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: att-uuid + in: path + required: true + type: string + - name: assignment-group-uuid + in: query + required: false + type: string + - name: name + in: query + required: false + type: string + put: + tags: + - LicenseManagement + summary: create or update an existing license-key-resource + description: create or update an existing license-key-resource + operationId: createOrUpdateLicenseManagementLicenseKeyResourcesLicenseKeyResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: att-uuid + in: path + required: true + type: string + - name: body + in: body + description: license-key-resource object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/license-key-resource" + delete: + tags: + - LicenseManagement + summary: delete an existing license-key-resource + description: delete an existing license-key-resource + operationId: deleteLicenseManagementLicenseKeyResourcesLicenseKeyResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: att-uuid + in: path + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /license-management/license-key-resources: + get: + tags: + - LicenseManagement + summary: returns license-key-resources + description: returns license-key-resources + operationId: getLicenseManagementLicenseKeyResources + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/license-key-resources" + "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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - name: metaname + in: path + required: true + 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: + - Business + summary: create or update an existing metadatum + description: create or update an existing metadatum + 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 + - name: metaname + in: path + required: true + type: string + - name: body + in: body + description: metadatum object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: metaname + in: path + required: true + type: string + - 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: "#/definitions/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 + - 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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: connector object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + /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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: metaname + in: path + required: true + type: string + - 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: 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 + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: metaname + in: path + required: true + type: string + - name: body + in: body + description: metadatum object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: metaname + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - 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: 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + 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/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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - 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: 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 + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - 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: 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + 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}: + 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - 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: 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 + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - name: body + in: body + description: allotted-resource object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + - 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - 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: 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - 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: 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 + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - name: body + in: body + description: service-instance object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + - 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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + /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: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - 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 + 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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - name: body + in: body + description: service-subscription object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: customer object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/customers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/vnf-images/vnf-image/{att-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: att-uuid + in: path + description: Unique ID of this asset + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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: att-uuid + in: path + description: Unique ID of this asset + required: true + type: string + /service-design-and-creation/vnf-images/vnf-image/{att-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: "#/definitions/vnf-image" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: att-uuid + in: path + description: Unique ID of this asset + required: true + 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: + - ServiceDesignAndCreation + summary: create or update an existing vnf-image + description: create or update an existing vnf-image + 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: att-uuid + in: path + description: Unique ID of this asset + required: true + type: string + - name: body + in: body + description: vnf-image object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: att-uuid + in: path + description: Unique ID of this asset + required: true + type: string + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: service object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - 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 + /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: "#/definitions/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 + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing service-capability + description: create or update an existing service-capability + 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 + - 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 + - name: body + in: body + description: service-capability object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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 + - 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: element-choice-set-uuid + in: path + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: element-choice-set-uuid + in: path + 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/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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: element-choice-set-uuid + in: path + required: true + type: string + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing element-choice-set + description: create or update an existing element-choice-set + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: element-choice-set-uuid + in: path + required: true + type: string + - name: body + in: body + description: element-choice-set object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: element-choice-set-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - 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 + /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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + 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}: + 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing constrained-element-set + description: create or update an existing constrained-element-set + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - name: body + in: body + description: constrained-element-set object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: constrained-element-set-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - 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 + /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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-constraint + description: create or update an existing model-constraint + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - name: body + in: body + description: model-constraint object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: model-constraint-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - 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 + /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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + 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}: + 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-element + description: create or update an existing model-element + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - name: body + in: body + description: model-element object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: model-element-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - 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 + /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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: metaname + in: path + required: true + type: string + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing metadatum + description: create or update an existing metadatum + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: metaname + in: path + required: true + type: string + - name: body + in: body + description: metadatum object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: metaname + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - 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 + /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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + /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: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-ver + description: create or update an existing model-ver + 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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - name: body + in: body + description: model-ver object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: model object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: related-lookup-uuid + in: path + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: related-lookup-uuid + in: path + 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/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: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: related-lookup-uuid + in: path + required: true + type: string + - 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 + 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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: related-lookup-uuid + in: path + required: true + type: string + - name: body + in: body + description: related-lookup object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: related-lookup-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: property-constraint-uuid + in: path + required: true + type: string + - 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 + 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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: property-constraint-uuid + in: path + required: true + type: string + - name: body + in: body + description: property-constraint object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: property-constraint-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - 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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: named-query-element-uuid + in: path + 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}: + 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: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - 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 + 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 + - name: named-query-element-uuid + in: path + required: true + type: string + - name: body + in: body + description: named-query-element object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: named-query-element-uuid + in: path + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: named-query object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: logical-link object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: cos + in: path + description: unique identifier of probe + 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/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: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + put: + tags: + - Network + summary: create or update an existing class-of-service + description: create or update an existing class-of-service + 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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + - name: body + in: body + description: class-of-service object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + - 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: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + 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}/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + 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}: + 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: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + put: + tags: + - Network + summary: create or update an existing site-pair + description: create or update an existing site-pair + 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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - name: body + in: body + description: site-pair object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + - 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: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + /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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + /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: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + put: + tags: + - Network + summary: create or update an existing routing-instance + description: create or update an existing routing-instance + 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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - name: body + in: body + description: routing-instance object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + - 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: "#/definitions/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 + /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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + put: + tags: + - Network + summary: create or update an existing site-pair-set + description: create or update an existing site-pair-set + 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 + - name: body + in: body + description: site-pair-set object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + /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: "#/definitions/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 + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + - 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 + 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 + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + - name: body + in: body + description: route-target object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: vpn-binding object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + /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: "#/definitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - name: body + in: body + description: sriov-pf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - 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: "#/definitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + 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: 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + 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: 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + 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/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: "#/definitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + 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: 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + 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: 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: "#/definitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: body + in: body + description: p-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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: "#/definitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + 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}/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + 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: 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + 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/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: "#/definitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + 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: 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + 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: 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: "#/definitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + 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: 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: lag-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - 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: "#/definitions/vpls-pe" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + - 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 + 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 + - name: body + in: body + description: vpls-pe object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + put: + tags: + - Network + summary: create or update an existing multicast-configuration + description: create or update an existing multicast-configuration + 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 + - name: body + in: body + description: multicast-configuration object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + /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: "#/definitions/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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + - 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 + 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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + - name: body + in: body + description: cvlan-tag-entry object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + - 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: "#/definitions/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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - 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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + /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: "#/definitions/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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - 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 + 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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - name: body + in: body + description: port-group object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + /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: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - 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 + 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: body + in: body + description: license object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + /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: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - 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 + 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: body + in: body + description: entitlement object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: vce object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/vces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vpes/vpe/{vnf-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpesVpeRelationshipListRelationship + consumes: + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeRelationshipListRelationship + consumes: + - 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 + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlan + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlan + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkVpesVpeLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 map strictly 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: 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/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 map strictly 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: 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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVpesVpeLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterface + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVpesVpeLInterfacesLInterface + consumes: + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVpesVpeLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - 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 map strictly 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 + /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 map strictly 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: 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/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 map strictly 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: 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/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{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: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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 map strictly 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: 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/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkVpesVpeLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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 map strictly 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: 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 + operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterface + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: lag-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkVpesVpeLagInterfacesLagInterface + consumes: + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkVpesVpeLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - 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 map strictly 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 + /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpesVpeLicensesLicenseRelationshipListRelationship + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeLicensesLicenseRelationshipListRelationship + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns license + description: returns license + operationId: getNetworkVpesVpeLicensesLicense + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - 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 map strictly 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 + put: + tags: + - Network + summary: create or update an existing license + description: create or update an existing license + operationId: createOrUpdateNetworkVpesVpeLicensesLicense + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: body + in: body + description: license object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/license" + delete: + tags: + - Network + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkVpesVpeLicensesLicense + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/licenses: + get: + tags: + - Network + summary: returns licenses + description: returns licenses + operationId: getNetworkVpesVpeLicenses + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - 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 map strictly 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 + /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpesVpeEntitlementsEntitlementRelationshipListRelationship + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpesVpeEntitlementsEntitlementRelationshipListRelationship + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns entitlement + description: returns entitlement + operationId: getNetworkVpesVpeEntitlementsEntitlement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - 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 map strictly 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 + put: + tags: + - Network + summary: create or update an existing entitlement + description: create or update an existing entitlement + operationId: createOrUpdateNetworkVpesVpeEntitlementsEntitlement + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: body + in: body + description: entitlement object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/entitlement" + delete: + tags: + - Network + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkVpesVpeEntitlementsEntitlement + consumes: + - 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes/vpe/{vnf-id}/entitlements: + get: + tags: + - Network + summary: returns entitlements + description: returns entitlements + operationId: getNetworkVpesVpeEntitlements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/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 + - 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 map strictly 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 + /network/vpes/vpe/{vnf-id}: + get: + tags: + - Network + summary: returns vpe + description: returns vpe + operationId: getNetworkVpesVpe + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/vpe" + "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 + - 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 map strictly 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 + put: + tags: + - Network + summary: create or update an existing vpe + description: create or update an existing vpe + operationId: createOrUpdateNetworkVpesVpe + consumes: + - 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 + - name: body + in: body + description: vpe object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/vpe" + delete: + tags: + - Network + summary: delete an existing vpe + description: delete an existing vpe + operationId: deleteNetworkVpesVpe + consumes: + - 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 + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpes: + get: + tags: + - Network + summary: returns vpes + description: returns vpes + operationId: getNetworkVpes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/vpes" + "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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: vnfc object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/vnfcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /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 + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + /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: "#/definitions/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 + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + - 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 + 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 + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + - name: body + in: body + description: subnet object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + /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: "#/definitions/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 + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + - 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 + 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 + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + - name: body + in: body + description: ctag-assignment object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + - 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: "#/definitions/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 + - 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 + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + /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: "#/definitions/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 + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + - 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 + 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 + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: l3-network object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: network-policy object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + 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}/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + 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/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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: lag-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + /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: "#/definitions/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 + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + - 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 + 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 + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + - name: body + in: body + description: vf-module object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + /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: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - 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 + 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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - name: body + in: body + description: license object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + /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: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - 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 + 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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - name: body + in: body + description: entitlement object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + - 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: "#/definitions/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 + - 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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: generic-vnf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + put: + tags: + - Network + summary: create or update an existing lag-link + description: create or update an existing lag-link + 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 + - name: body + in: body + description: lag-link object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - 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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: newvce object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - name: body + in: body + description: sriov-pf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - name: body + in: body + description: p-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + - 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: "#/definitions/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 + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + 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}/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + 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-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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + 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-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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - name: body + in: body + description: vlan object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - name: body + in: body + description: sriov-vf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + /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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + /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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + - 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + 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}: + 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - name: body + in: body + description: l-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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 + 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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - name: body + in: body + description: lag-interface object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + - 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: "#/definitions/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 + - 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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: pnf object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: physical-link object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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 + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + /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: "#/definitions/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 + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + put: + tags: + - Network + summary: create or update an existing vig-server + description: create or update an existing vig-server + 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 + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + - name: body + in: body + description: vig-server object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + - 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: "#/definitions/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 + /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: "#/definitions/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 + put: + tags: + - Network + summary: create or update an existing ipsec-configuration + description: create or update an existing ipsec-configuration + 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 + - name: body + in: body + description: ipsec-configuration object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: route-table-reference object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: instance-group object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/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 + - name: body + in: body + description: relationship object that needs to be created or updated + 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 + /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: "#/definitions/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 + - 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 + 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 + - name: body + in: body + description: zone object that needs to be created or updated + required: true + schema: + $ref: "#/definitions/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 + - 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: "#/definitions/zones" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). +definitions: + 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" + 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" + 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. + 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. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/definitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/definitions/related-to-property" + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/definitions/relationship" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO availability-zone (Many2Many) + - FROM complex (is composed of ctag-pool) + - FROM vpe + - FROM vpls-pe + - FROM generic-vnf + 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" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Default Delete Scope + ERROR_4_IN_EDGES_OR_CASCADE + ###### Related Nodes + - TO ctag-pool (comprises complex, Many2Many) + - TO l3-network (Many2Many) + - FROM availability-zone + - FROM cloud-region + - FROM oam-network + - FROM pserver + - FROM pnf + - FROM vce + - FROM vpe + - FROM vpls-pe + - FROM volume-group + - FROM zone + - FROM generic-vnf + 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" + volume-group: + description: | + Persistent block-level storage. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO complex (Many2Many) + - TO tenant (Many2Many) + - FROM cloud-region (is composed of volume-group) + - FROM vf-module + - FROM generic-vnf + 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" + volume: + description: | + Ephemeral Block storage volume. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM vserver (is composed of 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" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/definitions/volume" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO instance-group (Many2Many) + - TO l3-network (Many2Many) + - TO subnet (Many2Many) + - FROM l-interface (is composed of l3-interface-ipv4-address-list) + - FROM vlan (is composed of l3-interface-ipv4-address-list) + 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 + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO instance-group (Many2Many) + - TO l3-network (Many2Many) + - TO subnet (Many2Many) + - FROM l-interface (is composed of l3-interface-ipv6-address-list) + - FROM vlan (is composed of l3-interface-ipv6-address-list) + 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" + vlan: + description: | + Definition of vlan + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO l3-interface-ipv4-address-list (comprises vlan, Many2Many) + - TO l3-interface-ipv6-address-list (comprises vlan, Many2Many) + - TO multicast-configuration (Many2Many) + - TO logical-link (Many2Many, will delete target node) + - FROM l-interface (is composed of vlan) + - FROM service-instance + - FROM allotted-resource + required: + - vlan-interface + - in-maint + 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]. + 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" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO sriov-pf (Many2One) + - FROM l-interface (is composed of sriov-vf) + 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" + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO instance-group (Many2Many) + - TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many) + - TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many) + - TO l-interface (comprises l-interface, One2Many) + - TO logical-link (Many2Many, will delete target node) + - TO vlan (comprises l-interface, Many2Many) + - TO sriov-vf (comprises l-interface, One2One) + - FROM generic-vnf (is composed of l-interface) + - FROM lag-interface (is composed of l-interface) + - FROM newvce (is composed of l-interface) + - FROM p-interface (is composed of l-interface) + - FROM vpe (is composed of l-interface) + - FROM vserver (is composed of l-interface) + - FROM allotted-resource + - FROM l-interface (is composed of l-interface) + required: + - interface-name + - is-port-mirrored + - in-maint + 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]. + 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" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO flavor (Many2One) + - TO image (Many2One) + - TO ipaddress (comprises vserver, Many2Many) + - TO l-interface (comprises vserver, Many2Many) + - TO pserver (Many2One) + - TO volume (comprises vserver, Many2Many) + - TO vnfc (Many2Many) + - TO snapshot (One2One) + - TO vf-module (Many2One) + - FROM generic-vnf + - FROM tenant (is composed of vserver) + - FROM vce + - FROM vpe + 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" + tenant: + description: | + Openstack tenant + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO l3-network (Many2Many) + - TO service-subscription (Many2Many) + - TO vserver (comprises tenant, One2Many) + - FROM cloud-region (is composed of tenant) + - FROM group-assignment + - FROM volume-group + 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 + 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" + flavor: + description: | + Openstack flavor. + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + ###### Related Nodes + - FROM cloud-region (is composed of flavor) + - FROM 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" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO tenant (Many2Many) + - TO pserver (One2Many) + - FROM cloud-region (is composed of group-assignment) + 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" + snapshot: + description: | + Openstack snapshot + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM cloud-region (is composed of snapshot) + - FROM vserver + 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" + metadatum: + description: | + Key/value pairs + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM image (is composed of metadatum) + - FROM model-ver (is composed of metadatum) + - FROM service-instance (is composed of metadatum) + - FROM connector (is composed of metadatum) + 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. + metadata: + description: | + Collection of metadatum (key/value pairs) + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM image (is composed of metadata) + properties: + metadatum: + type: array + items: + $ref: "#/definitions/metadatum" + image: + description: | + Openstack image. + ###### Default Delete Scope + ERROR_4_IN_EDGES_OR_CASCADE + ###### Related Nodes + - TO metadata (comprises image, Many2Many) + - TO metadatum (comprises image, Many2Many) + - FROM cloud-region (is composed of image) + - FROM vserver + 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" + 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. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO availability-zone (Many2Many) + - FROM cloud-region (is composed of dvs-switch) + 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 VPEs. + properties: + dvs-switch: + type: array + items: + $ref: "#/definitions/dvs-switch" + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + ###### Related Nodes + - TO complex (Many2Many) + - TO service-capability (Many2Many) + - FROM cloud-region (is composed of oam-network) + 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" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + ###### Related Nodes + - TO complex (Many2Many) + - TO service-capability (Many2Many) + - FROM cloud-region (is composed of availability-zone) + - FROM ctag-pool + - FROM dvs-switch + - FROM generic-vnf + - FROM pserver + - FROM 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" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC 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 and we will use att-aic for AT&T's AIC. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO complex (Many2One) + - TO l3-network (Many2Many) + - TO tenant (comprises cloud-region, One2Many) + - TO image (comprises cloud-region, One2Many) + - TO flavor (comprises cloud-region, One2Many) + - TO availability-zone (comprises cloud-region, One2Many) + - TO oam-network (comprises cloud-region, One2Many) + - TO dvs-switch (comprises cloud-region, One2Many) + - TO volume-group (comprises cloud-region, One2Many) + - TO group-assignment (comprises cloud-region, One2Many) + - TO snapshot (comprises cloud-region, One2Many) + - TO zone (Many2One) + - FROM pserver + - FROM logical-link + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name, e.g., att-aic. 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 + 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" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/definitions/cloud-region" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM generic-vnf + 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" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM p-interface (is composed of sriov-pf) + - FROM sriov-vf + 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" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO l-interface (comprises p-interface, Many2Many) + - TO physical-link (Many2Many, will delete target node) + - TO logical-link (Many2One) + - TO sriov-pf (comprises p-interface, One2One) + - FROM lag-interface + - FROM pserver (is composed of p-interface) + - FROM pnf (is composed of p-interface) + - FROM vpls-pe (is composed of p-interface) + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + 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. + 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" + lag-interface: + description: | + Link aggregate interface + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO logical-link (Many2Many, will delete target node) + - TO lag-link (Many2Many, will delete target node) + - TO p-interface (Many2Many) + - TO l-interface (comprises lag-interface, Many2Many) + - FROM generic-vnf (is composed of lag-interface) + - FROM pserver (is composed of lag-interface) + - FROM pnf (is composed of lag-interface) + - FROM vpe (is composed of lag-interface) + - FROM vpls-pe (is composed of lag-interface) + 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" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Default Delete Scope + ERROR_4_IN_EDGES_OR_CASCADE + ###### Related Nodes + - TO complex (Many2One) + - TO cloud-region (Many2One) + - TO availability-zone (Many2One) + - TO lag-interface (comprises pserver, Many2Many) + - TO p-interface (comprises pserver, Many2Many) + - TO zone (Many2One) + - FROM generic-vnf + - FROM group-assignment + - FROM vserver + - FROM logical-link + 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" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO generic-vnf (Many2Many) + - TO logical-link (Many2Many) + - FROM connector + 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" + 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" + license-key-resource: + description: | + OBSOLETE OBJECT: do not use + ###### Related Nodes + - FROM generic-vnf + required: + - att-uuid + - assignment-group-uuid + properties: + att-uuid: + type: string + assignment-type: + type: string + assignment-status: + type: string + assignment-group-uuid: + type: string + assignment-date: + type: string + name: + type: string + model-uuid: + type: string + model-version: + type: string + license-key: + type: string + license-key-file-url: + type: string + supplier-release-list: + type: 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" + license-key-resources: + properties: + license-key-resource: + type: array + items: + $ref: "#/definitions/license-key-resource" + license-management: + properties: + license-key-resources: + type: array + items: + $ref: "#/definitions/license-key-resource" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO virtual-data-center (Many2Many) + - TO metadatum (comprises connector, Many2Many) + - FROM service-instance + 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" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM allotted-resource (is composed of tunnel-xconnect) + required: + - id + - bandwidth-up-wan1 + - bandwidth-down-wan1 + - bandwidth-up-wan2 + - bandwidth-down-wan2 + 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" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO generic-vnf (Many2Many) + - TO l3-network (Many2Many) + - TO instance-group (Many2Many) + - TO network-policy (One2One) + - TO vlan (Many2Many) + - TO l-interface (One2Many) + - TO tunnel-xconnect (comprises allotted-resource, One2One) + - TO vpn-binding (Many2Many) + - FROM service-instance (is composed of allotted-resource) + - FROM service-instance + 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" + service-instance: + description: | + Instance of a service + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO zone (Many2One) + - TO cvlan-tag (Many2Many) + - TO pnf (One2Many) + - TO connector (Many2Many) + - TO metadatum (comprises service-instance, Many2Many) + - TO logical-link (Many2Many, will delete target node) + - TO vlan (One2Many) + - TO service-instance (One2Many) + - TO ctag-assignment (One2Many) + - TO instance-group (Many2Many) + - TO allotted-resource (comprises service-instance, Many2Many) + - TO allotted-resource (Many2Many) + - FROM generic-vnf + - FROM l3-network + - FROM service-subscription (is composed of service-instance) + - FROM vce + - FROM service-instance + required: + - service-instance-id + 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. + 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. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO service-instance (comprises service-subscription, Many2Many) + - FROM customer (is composed of service-subscription) + - FROM tenant + 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" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO service-subscription (comprises customer, Many2Many) + 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" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/definitions/connector" + customers: + type: array + items: + $ref: "#/definitions/customer" + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + ###### Related Nodes + - FROM generic-vnf + required: + - att-uuid + - application + - application-vendor + properties: + att-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" + 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. + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + 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" + 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" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + ###### Related Nodes + - FROM availability-zone + - FROM 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-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/definitions/service-capability" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO model-element (comprises element-choice-set, One2Many) + - FROM constrained-element-set (is composed of element-choice-set) + 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" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO element-choice-set (comprises constrained-element-set, One2Many) + - FROM model-element (is composed of constrained-element-set) + - FROM model-constraint (is composed of constrained-element-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" + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO constrained-element-set (comprises model-constraint, One2Many) + - FROM model-element (is composed of model-constraint) + 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. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO model-ver (Many2One) + - TO model-element (comprises model-element, One2Many) + - TO model-constraint (comprises model-element, One2Many) + - TO constrained-element-set (comprises model-element, One2Many) + - FROM model-ver (is composed of model-element) + - FROM element-choice-set (is composed of model-element) + - FROM model-element (is composed of model-element) + 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 + ###### Default Delete Scope + ERROR_4_IN_EDGES_OR_CASCADE + ###### Related Nodes + - TO model-element (comprises model-ver, One2Many) + - TO metadatum (comprises model-ver, One2Many) + - FROM model (is composed of model-ver) + - FROM 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 + 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" + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Default Delete Scope + ERROR_4_IN_EDGES_OR_CASCADE + ###### Related Nodes + - TO model-ver (comprises model, One2Many) + - FROM named-query + - FROM named-query-element + - FROM instance-group + 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" + 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" + related-lookup: + description: | + TBD + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - FROM named-query-element (is composed of related-lookup) + 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" + property-constraint: + description: | + TBD + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - FROM named-query-element (is composed of property-constraint) + 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" + named-query-element: + description: | + TBD + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO named-query-element (comprises named-query-element, Many2Many) + - TO model (Many2One) + - TO property-constraint (comprises named-query-element, One2Many) + - TO related-lookup (comprises named-query-element, One2Many) + - FROM named-query (is composed of named-query-element) + - FROM named-query-element (is composed of named-query-element) + 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" + named-query: + description: | + TBD + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO model (One2Many) + - TO named-query-element (comprises named-query, One2One) + 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-queries: + properties: + named-query: + type: array + items: + $ref: "#/definitions/named-query" + 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" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO lag-link (Many2Many) + - TO pnf (Many2Many) + - TO logical-link (One2Many) + - TO generic-vnf (Many2Many) + - TO pserver (Many2Many) + - TO cloud-region (Many2Many) + - TO vpn-binding (Many2Many) + - FROM l-interface + - FROM lag-interface + - FROM p-interface + - FROM service-instance + - FROM virtual-data-center + - FROM vlan + - FROM logical-link + required: + - link-name + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + 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 (should be att-ip-version) + 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" + class-of-service: + description: | + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM site-pair (is composed of class-of-service) + 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" + site-pair: + description: | + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO class-of-service (comprises site-pair, Many2Many) + - FROM routing-instance (is composed of site-pair) + 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-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/definitions/site-pair" + routing-instance: + description: | + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO site-pair (comprises routing-instance, Many2Many) + - FROM site-pair-set (is composed of routing-instance) + 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" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO routing-instance (comprises site-pair-set, Many2Many) + - FROM generic-vnf + 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" + route-target: + description: | + Route target information + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - FROM vpn-binding (is composed of route-target) + 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" + vpn-binding: + description: | + VPN binding + ###### Default Delete Scope + ERROR_4_IN_EDGES_OR_CASCADE + ###### Related Nodes + - TO route-target (comprises vpn-binding, One2Many) + - FROM l3-network + - FROM logical-link + - FROM allotted-resource + 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" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO complex (Many2Many) + - TO ctag-pool (Many2Many) + - TO p-interface (comprises vpls-pe, Many2Many) + - TO lag-interface (comprises vpls-pe, Many2Many) + 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 vpe, also used for troubleshooting and is IP used for traps generated by VPE (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" + multicast-configuration: + description: | + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM vlan + 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" + 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" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO cvlan-tag (comprises port-group, Many2Many) + - FROM vce (is composed of port-group) + 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" + license: + description: | + Metadata for license group. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM generic-vnf (is composed of license) + - FROM vce (is composed of license) + - FROM vpe (is composed of license) + 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" + entitlement: + description: | + Metadata for entitlement group. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM generic-vnf (is composed of entitlement) + - FROM vce (is composed of entitlement) + - FROM vpe (is composed of entitlement) + 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" + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO availability-zone (Many2Many) + - TO complex (Many2Many) + - TO port-group (comprises vce, Many2Many) + - TO vserver (Many2Many) + - TO service-instance (Many2Many) + - TO entitlement (comprises vce, One2Many) + - TO license (comprises vce, One2Many) + 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" + vpe: + description: | + Relationship-list must include related to info for complex. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO complex (Many2Many) + - TO ctag-pool (Many2Many) + - TO l-interface (comprises vpe, Many2Many) + - TO lag-interface (comprises vpe, Many2Many) + - TO vserver (Many2Many) + - TO entitlement (comprises vpe, One2Many) + - TO license (comprises vpe, One2Many) + 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 map strictly 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. See child relationships. + equipment-role: + type: string + description: Client should send valid enumerated value + 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 + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address). + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + ipv4-oam-gateway-address: + type: string + description: Gateway address + v4-loopback0-ip-address: + type: string + description: Loopback0 address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + as-number: + type: string + description: as-number of the VPE + 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 vpe operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether vpe access uses SSH + 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" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + vpes: + description: | + Virtual provider edge router. In 1504, A&AI will populate this object through an M&P and tool provided to operations. + properties: + vpe: + type: array + items: + $ref: "#/definitions/vpe" + vnfc: + description: | + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO instance-group (Many2Many) + - FROM vserver + - FROM vf-module + - FROM generic-vnf + 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" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/definitions/vnfc" + subnet: + description: | + ###### Default Delete Scope + ERROR_IF_ANY_IN_EDGES + ###### Related Nodes + - FROM l3-interface-ipv4-address-list + - FROM l3-interface-ipv6-address-list + - FROM l3-network (is composed of subnet) + 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 + 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" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/definitions/subnet" + ctag-assignment: + description: | + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM l3-network (is composed of ctag-assignment) + - FROM service-instance + 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" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM l3-network (is composed of segmentation-assignment) + 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" + l3-network: + description: | + Generic network definition + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO vpn-binding (Many2Many) + - TO instance-group (Many2Many) + - TO subnet (comprises l3-network, Many2Many) + - TO service-instance (Many2Many) + - TO ctag-assignment (comprises l3-network, Many2Many) + - TO network-policy (Many2Many) + - TO segmentation-assignment (comprises l3-network, One2Many) + - TO route-table-reference (Many2Many) + - FROM cloud-region + - FROM complex + - FROM generic-vnf + - FROM l3-interface-ipv4-address-list + - FROM l3-interface-ipv6-address-list + - FROM tenant + - FROM vf-module + - FROM allotted-resource + 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" + network-policy: + description: | + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM l3-network + - FROM allotted-resource + 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-policies: + properties: + network-policy: + type: array + items: + $ref: "#/definitions/network-policy" + vf-module: + description: | + a deployment unit of VNFCs + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO volume-group (One2One) + - TO l3-network (Many2Many) + - TO vnfc (One2Many, will delete target node) + - FROM vserver + - FROM generic-vnf (is composed of vf-module) + 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" + generic-vnf: + description: | + General purpose VNF + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO license-key-resource (Many2Many) + - TO l-interface (comprises generic-vnf, Many2Many) + - TO availability-zone (Many2Many) + - TO lag-interface (comprises generic-vnf, Many2Many) + - TO l3-network (Many2Many) + - TO pserver (Many2Many) + - TO vnf-image (Many2One) + - TO vserver (One2Many) + - TO service-instance (Many2Many) + - TO site-pair-set (Many2Many) + - TO network-profile (Many2Many) + - TO pnf (Many2Many) + - TO ipsec-configuration (Many2One) + - TO vf-module (comprises generic-vnf, One2Many) + - TO volume-group (One2Many) + - TO vnfc (One2Many, will delete target node) + - TO instance-group (Many2Many) + - TO entitlement (comprises generic-vnf, One2Many) + - TO license (comprises generic-vnf, One2Many) + - TO complex (Many2Many) + - TO ctag-pool (Many2Many) + - FROM virtual-data-center + - FROM logical-link + - FROM allotted-resource + required: + - vnf-id + - vnf-name + - vnf-type + - in-maint + - is-closed-loop-disabled + 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 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. + 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 + 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" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM lag-interface + - FROM logical-link + 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" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO l-interface (comprises newvce, Many2Many) + 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 vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPE. + 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" + 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. + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO p-interface (comprises pnf, Many2Many) + - TO lag-interface (comprises pnf, One2Many) + - TO complex (Many2One) + - TO instance-group (Many2Many) + - TO zone (Many2One) + - FROM generic-vnf + - FROM logical-link + - FROM service-instance + 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. + 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" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM p-interface + 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. + 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" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM ipsec-configuration (is composed of vig-server) + 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" + 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 + ###### Default Delete Scope + CASCADE_TO_CHILDREN + ###### Related Nodes + - TO vig-server (comprises ipsec-configuration, One2Many) + - FROM generic-vnf + 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" + route-table-reference: + description: | + Openstack route table reference. + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - FROM l3-network + 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" + instance-group: + description: | + General mechanism for grouping instances + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO model (Many2Many) + - FROM l-interface + - FROM vnfc + - FROM l3-interface-ipv4-address-list + - FROM l3-interface-ipv6-address-list + - FROM l3-network + - FROM pnf + - FROM allotted-resource + - FROM generic-vnf + - FROM service-instance + 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" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Default Delete Scope + THIS_NODE_ONLY + ###### Related Nodes + - TO complex (Many2One) + - FROM cloud-region + - FROM pserver + - FROM pnf + - FROM service-instance + 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" + 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" + vpes: + type: array + items: + $ref: "#/definitions/vpe" + 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" + inventory: + properties: + search: + type: object + $ref: "#/definitions/search" + actions: + type: object + $ref: "#/definitions/actions" + cloud-infrastructure: + type: object + $ref: "#/definitions/cloud-infrastructure" + license-management: + type: object + $ref: "#/definitions/license-management" + 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/" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/definitions/inventory-item" + 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 + 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" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + include-node-filter: + properties: + include-node-type: + type: string + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + search-results: + properties: + result-data: + type: array + items: + $ref: "#/definitions/result-data" + 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 + 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" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/definitions/dvs-switches" + availability-zone: + type: object + $ref: "#/definitions/availability-zone" + 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" + 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 + update-node-key: + properties: + key-name: + type: string + key-value: + 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 + key-data: + properties: + key-name: + type: string + key-value: + type: string + 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 + 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 + 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 + isParent: + type: boolean + usesResource: + type: boolean + hasDelTarget: + type: boolean + SVC-INFRA: + type: boolean + SVC-INFRA-REV: + type: boolean + 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 + 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" + 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" + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/definitions/instance-filter" + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/definitions/secondary-filt" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + 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" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/definitions/inventory-response-item" + 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" + 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 + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. -- cgit 1.2.3-korg